Commit graph

176 commits

Author SHA1 Message Date
James Cammarata 6f405c8970 Updated footer date and adding in misc. file generated by earlier doc update 2014-02-12 16:14:41 -06:00
Maykel Moya 0b1320e48c Update doc, irc and mailing list information in manpages input 2014-02-12 16:02:33 +01:00
Maykel Moya 06beddfe68 Fix documentation url 2014-02-11 16:55:10 +01:00
Maykel Moya 0b44a3e54f Minor grammar fix in manpages 2014-02-11 16:50:10 +01:00
Michael DeHaan 388365b90a Add reference to Guru to sidebar. 2014-01-30 12:32:45 -05:00
Matthew Phipps d78951e767 Add skip_tags to ansible-playbook man page 2014-01-27 18:03:10 -05:00
Michael DeHaan 0882eefdff Merge conflict 2014-01-03 11:06:32 -05:00
Michael DeHaan 2f811c40d7 Basic docsite formatting fixups 2014-01-02 17:36:52 -05:00
Michael DeHaan fdb8505a5e Add ansible-pull's -o to the manpage. 2013-12-27 15:33:33 -05:00
Michael DeHaan 52b2cfedfc Add release history for 1.4.1 into 1.5 branch. 2013-11-27 18:41:07 -05:00
Michael DeHaan f7c3975f21 Add version_added to all modules missing version_added information, the docs formatter will now
raise errors when omitted, updated changelog with new modules.
2013-11-18 18:55:49 -05:00
jctanner 2d9087b806 Merge pull request #4484 from mscherer/add_short_hostname
ansible-pull by default will look for local.yml and $fqdn.yml.
2013-11-14 05:32:47 -08:00
jctanner 127efdf3ef Merge pull request #4576 from mscherer/pull_temporary_dir_2
add a default value for the -d option of ansible-pull
2013-11-05 14:47:09 -08:00
Ray b5266a562d minor correction
Same doc-typo (confirmed) as https://github.com/ansible/ansible/pull/4759

--remote-user  *should be*  --user
2013-10-31 19:29:46 -05:00
Ray a66f0462cd minor correction
--remote-user= does not work:
 ansible: error: no such option: --remote-user

--user= does. Updating docs
2013-10-31 17:56:52 -05:00
Michael DeHaan ad5731b4a8 Add module utils path to setup.py 2013-10-26 15:00:59 -04:00
Michael Scherer f8b23e5721 add a default value for the -d option of ansible-pull
Thi permit to simplify the command line to use by using
a sensible default, and so reduce the number of incorrect
possible choices and setup needed. Among potential
incorrect choices is using a fixed directory in /tmp, which
could be problematic with a setup whose access is not
properly restricted.
2013-10-18 02:05:41 +02:00
Michael Scherer 92147aff0f also fix the doc, forgot in last commit 2013-10-13 15:34:56 +02:00
James Cammarata 97e3e967a7 Merge branch 'devel' of https://github.com/jflorian/ansible into jflorian-devel 2013-09-20 22:01:50 -05:00
James Cammarata 8283183023 Adding sshpass as packaging requirement and fixing VERSION 2013-09-13 17:39:14 -05:00
John Florian c8a5aabf39 Added -f/--force option to ansible-pull 2013-09-03 16:39:19 -04:00
Stephen Fromm 77b8ee1f84 Update ansible-pull man page doc (issue #3372) 2013-08-20 13:43:26 -05:00
Michael DeHaan f0d7324e25 Merge pull request #3094 from sfromm/issue2464-redux
Updates to ansible-pull and ansible-pull docs
2013-06-03 09:01:39 -07:00
Michael DeHaan 4ae3ef8af9 Disable inventory test 2013-06-03 11:52:42 -04:00
Stephen Fromm a611027329 Update ansible-pull documentation 2013-06-01 21:44:52 -07:00
Michael DeHaan b19609b98b Slight docs tweak 2013-05-31 16:05:07 -04:00
Michael DeHaan 0837c9785f Merge pull request #3040 from bfabio/devel
Support JSON in --extra-vars.
2013-05-31 13:06:05 -07:00
Michael DeHaan 267b29cec7 Manpage tweaks, docs rebuild 2013-05-29 10:30:04 -04:00
Fabio Bonelli 6bef150695 Support JSON in --extra-vars.
If --extra-vars starts with either a '{' or a '[', it will be assumed
we are dealing with JSON and parse the data as such.
2013-05-28 09:46:50 +02:00
Michael Vogt d7b5b47efe improve wording, thanks to Michael DeHaan 2013-05-25 08:53:20 +02:00
Michael Vogt 22b0cf9275 use the same text for -M in ansible.1 and ansible-playbook.1 2013-05-23 21:34:33 +02:00
Michael Vogt 8338e75463 document in the man-page that {ansible,ansible-playbook} -M can also be overriden with the ANSIBLE_LIBRARY environment 2013-05-23 21:22:58 +02:00
Michael DeHaan aa4ad80bda Update release version. 2013-04-02 20:48:30 -04:00
Yves Dorfsman 8b10cc5946 Mention of ansible-doc and man pages for modules. 2013-03-18 20:31:42 -06:00
r-p-e 1f1eb4125f align manpages with actual code for --syntax-check 2013-03-06 00:42:53 +01:00
Michael DeHaan 2a66185920 update manpage for new options. 2013-02-16 15:38:59 -05:00
Oscar Korz ba807ed5a8 Correct -u description in ansible man page 2013-02-09 19:24:53 -08:00
Michael DeHaan 318e3302fb Fix up some version related things on the devel branch. 2013-02-01 21:38:21 -05:00
Michael DeHaan 70bb7d1e54 Merge pull request #1696 from gregorg/enhance_limit
Allow regex to be used to select hosts in addition to fnmatch pattern
2012-12-12 14:51:44 -08:00
Gregory Duchatelet ba4f71db27 Moved docs about "--limit=~REGEX" from man page to asciidoc. 2012-12-04 21:08:29 +01:00
Gregory Duchatelet 8bc1b69c58 Add a unit test to subset limiting via a regex, and some doc in man
page.
2012-12-02 10:18:58 +01:00
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