Jan-Piet Mens
17f31a2a79
CLI: ansible-doc shows lists of modules & module docs on command-line
...
check path is directory
added manpage & setup
small cleanup
shut up module_formatter in utils to avoid trace print on crud files in library
2012-11-30 21:57:25 -05:00
Michael DeHaan
6a5df97393
Manpage documentation ALSO should be sorted
2012-11-03 18:54:38 -04:00
Fabian Arrotin
96770a3057
- Fixed some typos for the ansible config file
...
- added the ANSIBLE_CONFIG environment variable
2012-10-30 17:08:12 +01:00
Michael DeHaan
5bdc16338e
Release version bump for 0.9 (development branch)
2012-10-19 21:01:57 -04:00
Michael DeHaan
aa98c84a62
HP and vsphere modules are crazy awesome but I am thinking these belong in contrib not core.
2012-10-12 17:49:48 -04:00
Michael DeHaan
70ed560fb3
Add FILES to manpage
2012-10-12 17:37:30 -04:00
Michael DeHaan
6d2f003ceb
Update formatter to not include orange blocks all over docsite page
2012-10-10 21:25:19 -04:00
Tim Bielawa
9541b47b52
Keep the man3 directory. 'make docs' breaks without it.
2012-10-08 12:28:20 -04:00
Michael DeHaan
343e07a31a
chapter 3 manpage source does not belong in git because it includes datestamps that constantly change. Willing to re-add if datestamps
...
are removable.
2012-10-08 08:10:37 -04:00
Michael DeHaan
4a95194424
Docs rebuild in new project structure.
2012-10-08 08:09:27 -04:00
Jan-Piet Mens
a9dad7f3bd
remove duplicate private-key option from manpage
2012-10-05 09:18:19 +02:00
Michael DeHaan
761330b125
Fix module formatter indexing
2012-10-03 23:31:50 -04:00
Tim Bielawa
85fb7c6d4b
Library functions and modules should be in the 3 man page section. Also the files should end in '.3'
2012-10-03 10:18:55 -04:00
Michael DeHaan
53d24ef002
Check in generated manpage documentation from modules
2012-10-02 22:46:49 -04:00
Michael DeHaan
31a4fe412f
Complain when modules do not have documentation.
2012-09-30 21:10:07 -04:00
Jan-Piet Mens
d47e15a1f2
module_formatter in hacking/
2012-09-26 20:41:44 +02:00
Michael DeHaan
975c323e39
Release version bump
2012-09-06 18:56:38 -04:00
Michael DeHaan
4920533c05
Add --limit to manpage
2012-09-06 18:42:18 -04:00
Tim Bielawa
698bcaa581
Fully document the -v option.
2012-08-15 10:13:38 -04:00
Tim Bielawa
6d9e873724
Add some docs/examples
...
Add a basic ansible-pull man page.
Add the example playbooks/scripts to the RPM package.
Closes #841
2012-08-14 13:05:44 -04:00
Tim Bielawa
bf7e83bea6
Update man pages and the message for an exception.
2012-08-09 10:22:43 -04:00
Michael DeHaan
6ea022de01
docs build
2012-08-06 19:57:23 -04:00
Michael DeHaan
8fa4dc3920
Small change to previous patch, make ranges of hosts inclusive.
2012-07-24 20:10:05 -04:00
Chin Fang
e3b2521f01
Added a host expansion feature to ansible's inventory parsing
2012-07-24 12:38:52 -07:00
Michael DeHaan
a490213d45
Release bump to start development on 0.6
2012-07-04 18:07:19 -04:00
Michael DeHaan
efac68b636
Remove the -D module debug flag, which no longer is functional due to sudo pty requirements, and replace with -v/--verbose.
...
This flag will show playbook output from non-failing commands. -v is also added to /usr/bin/ansible, but not yet used.
I also gutted some internals code dealing with 'invocations' which allowed the callback to know what module invoked
it. This is not something 0.5 does or needed, so callbacks have been simplified.
2012-06-19 21:57:43 -04:00
Michael DeHaan
da3816d370
Move version files to 0.5 for devel branch
2012-05-25 16:43:16 -04:00
Michael DeHaan
8e8cde3a2c
override hosts gone
2012-05-07 23:18:06 -04:00
Michael DeHaan
eda2333b24
Update manpage to mention -U (--sudo-user).
2012-05-06 18:32:43 -04:00
Michael DeHaan
36e454c52f
Because paramiko using a pty can't distinguish stderr and stdout, remove handling that
...
treated -D as a way to show stderr, and make sure modules don't include things on stderr.
Update docs and test module script to come into line.
2012-04-27 01:25:38 -04:00
Michael DeHaan
b9982fc17b
Reinstate --extra-vars, which can do things in playbooks like:
...
ansible-playbook release-my-app.yml --extra-vars="version=123"
And make $version available in the playbook without re-editing the file
2012-04-26 19:57:07 -04:00
Tim Bielawa
621dc83ac2
Fix man page option description indentation.
2012-04-17 11:39:51 -04:00
Tim Bielawa
d43cf592eb
Renaming asciidoc sources to .in.
...
Change manpages to build from *.in and add comments about how the make
targets work.
2012-04-17 10:31:40 -04:00
Tim Bielawa
2d26d1fd71
Update %description and auto-add version to manpages
...
Conflicts:
docs/man/man1/ansible-playbook.1
docs/man/man1/ansible.1
Update %description
2012-04-17 10:31:34 -04:00
Michael DeHaan
9ce27be878
Remove extra_vars tests
2012-04-16 23:03:04 -04:00
Michael DeHaan
b24ec71ca3
Update docs to reflect --port going away and --sudo and --remote-user being added to ansible-playbook
2012-04-16 22:22:37 -04:00
Michael DeHaan
579bd1d417
manpage updates
2012-04-13 19:40:40 -04:00
Michael DeHaan
c3cad50075
Update manpages, fix missing variable assignment
2012-04-13 19:33:19 -04:00
Stephen Fromm
b506567c37
Update ansible.1 manpage for option -c, --connection
2012-04-11 09:32:29 -07:00
John Eckersberg
5aad4bacc7
Bump release to 0.0.2
2012-04-03 09:51:05 -04:00
Tim Bielawa
446ba1795a
Show when options require arguments in the man pages.
2012-03-23 22:29:51 -04:00
Michael DeHaan
f1c8fc63cb
host file must be marked config(noreplace), update rpm build to use checked in manpage src
2012-03-31 11:08:42 -04:00
Michael DeHaan
9049b0e7ca
Because folks on RHEL 6 (not CentOS 6) have some issues with asciidoc, do not build the asciidoc from
...
the rpm or make install targets. Also modify the make install (only) to copy over files into the library
directory since the setup.py does not do this (due to a distutils bug, more or less).
2012-03-15 20:21:10 -04:00
Michael DeHaan
ee69bd18cc
Add -T to playbook manpage
2012-03-13 21:54:42 -04:00
Michael DeHaan
6660a5efbd
add polling info to manpage
2012-03-11 21:09:44 -04:00
Tim Bielawa
3f245498c4
Fixup RPM building: Makefile, Spec File, .gitignore
...
Fixup distutils: setup.py
Clean old cruft: section 5 man pages
2012-03-10 14:22:11 -05:00
Michael DeHaan
209760f8f6
Add manpage for ansible-playbook, since it is a command. More detailed docs will remain on the web site.
2012-03-09 22:06:44 -05:00
Michael DeHaan
742258a078
Drop other man(5) pages so we can have only one source of docs -- ansible.github.com for those operations.
...
Easier to maintain and much more verbose.
2012-03-08 13:56:27 -05:00
Tim Bielawa
f2c2786a14
Update constants.py to pull module path and the hosts file from the
...
environment (ANSIBLE_{LIBRARY,HOSTS}) if defined.
Update manpages to represent this.
Also update the env-setup script to set ANSIBLE_{LIBRARY,HOSTS}.
2012-03-05 16:08:36 -05:00
Tim Bielawa
6343aa6214
Add environment updating script 'env-setup' to facilitate running ansible from a git checkout.
2012-03-05 13:47:01 -05:00
Tim Bielawa
e9ae5eb9d5
Correct see-also in playbook manpage
2012-03-04 23:08:29 -05:00
Michael DeHaan
269a6d46d6
attempt to explain import syntax in ansible-playbook manpage. Can't include
...
examples inline because github won't display them well, want to move this
file to markdown soon.
2012-03-03 14:13:31 -05:00
Michael DeHaan
847846af0e
-p has been replaced by a required option. Various docs changes.
2012-03-01 22:10:47 -05:00
Michael DeHaan
4ce1f1dd5e
README/doc/example updates to go with group support and CLI option changes.
...
Minimizing manpage until CLI options stabilize.
2012-03-01 21:18:32 -05:00
Michael DeHaan
55d256d82a
Added solution to avoid checking in manpages. Just run "make" and we'll build
...
docs before python setup.py. Seems reasonable to let Makefile drive
2012-02-28 04:15:52 -05:00
Michael DeHaan
d8b5e667d8
Doc rebuild
2012-02-28 03:05:29 -05:00
Michael DeHaan
442c2488ba
Minor playbook doc updates
2012-02-28 22:10:58 -05:00
Michael DeHaan
d0906e187f
Correct file location error in example
2012-02-28 02:52:14 -05:00
Michael DeHaan
058fa5bd15
Manpage and doc updates
2012-02-28 02:51:19 -05:00
Michael DeHaan
6fcce9a97e
rebuild manpage due to license change
2012-02-28 01:25:00 -05:00
Michael DeHaan
be4cb64c92
Relicensing to GPLv3, all previous committers ok'd on mailing list.
2012-02-28 19:08:09 -05:00
Michael DeHaan
c0b4c80ba1
Docs rebuild
2012-02-27 23:54:32 -05:00
Michael DeHaan
783d3642a8
ok, giving up, github does not render asciidoc well at all.
...
Is there something we can use to generate manpages from markdown?
2012-02-27 23:48:40 -05:00
Michael DeHaan
28afd7208e
Try once more.
2012-02-27 23:47:10 -05:00
Michael DeHaan
03bf465c3a
attempt to fix asciidoc so it shows up on github
2012-02-27 23:42:15 -05:00
Michael DeHaan
f3246fb72e
Remove 'pending' comment.
2012-02-27 23:39:47 -05:00
Michael DeHaan
4201865bba
Add note about facter/ohai integration into module docs.
2012-02-27 23:18:53 -05:00
Michael DeHaan
e766bb6a6c
update manpage output
2012-02-27 22:49:14 -05:00
Michael DeHaan
155c3ca89e
update playbook docs with updated syntax / minor edits
2012-02-27 22:48:45 -05:00
Michael DeHaan
2860c14bc2
module doc updates
2012-02-27 22:43:08 -05:00
Michael DeHaan
ba4e36a9a9
Rename 'ensure' to 'state' because I think it's a bit cleaner and doesn't imply
...
all modules take a common parameter name. But more or less we still work idempotently
in modules.
2012-02-26 22:31:42 -05:00
Tim Bielawa
6612772711
Update man pages. Fix formatting in playbook example. Also, YAML documents by definition start with '---', so I have added this to the example and the manpage
2012-02-26 21:09:56 -05:00
Tim Bielawa
afc7f4d246
This is configuration, not command. Rename to section 5
2012-02-26 21:03:55 -05:00
Tim Bielawa
9680de37c9
Manpages formatting
2012-02-26 21:03:18 -05:00
Tim Bielawa
b4fd0042f6
Fix up some wording/formatting in ansible-modyles.5. Also: Section 5 is for configuration, update the see-also to reflect this with respect to ansible-playbook.
2012-02-26 21:01:04 -05:00
Tim Bielawa
86bf871e07
Fixup the naming of the docs.
2012-02-26 21:01:04 -05:00
Michael DeHaan
136d8fa33a
add manpage crossreferences
2012-02-26 20:48:10 -05:00
Michael DeHaan
2262705ea3
Added stub for ansible-playbook (format) docs. Docs on ansible-playbook script TBD once
...
written.
2012-02-26 20:47:22 -05:00
Michael DeHaan
17a6ddb7ee
Lining up with the reversion of 70ec508ee0
, also
...
check the ansible-module file back in. This is basically to make things easier
to build from setup.py.
2012-02-26 20:01:31 -05:00
Michael DeHaan
4e5da11217
Revert "don't check in manpage output file"
...
This reverts commit 70ec508ee0
.
2012-02-26 20:00:46 -05:00
Michael DeHaan
226da501d3
Take notes about other modules that are in plan.
2012-02-26 19:29:56 -05:00
Michael DeHaan
e5f62f20b1
make copy & template module take key/value parameters so we're consistent. Only the command
...
module works differently now
starter manpage for modules
allow template file location to be passed into template & setup modules
2012-02-26 19:21:44 -05:00
Michael DeHaan
77a7ddeebc
Add start of documentation for modules
2012-02-26 18:52:42 -05:00
Michael DeHaan
70ec508ee0
don't check in manpage output file
2012-02-25 17:19:12 -05:00
Tim Bielawa
f0b0211772
Because everything should have a man page
2012-02-24 20:07:49 -05:00