Michael DeHaan
40429ee64e
Code to limit display of version_added attributions in modules for modules that are too old to call out this information.
This does not generically apply to new arguments added to existing modules, just the version_added attribute on the top level modules. |
11 years ago | |
---|---|---|
.. | ||
templates | make comment lines in troff start with .\" and add a .SH EXAMPLES to the PLAINEXAMPLES section | 11 years ago |
README.md | Fix module path in readme file. | 11 years ago |
authors.sh | fixed x-bits in git | 12 years ago |
env-setup | Add zsh support for working dir independant sourcing | 11 years ago |
env-setup.fish | Fixed usage comment to fish syntax for sourcing a file | 11 years ago |
module_formatter.py | Code to limit display of version_added attributions in modules for modules that are too old to call out this information. | 11 years ago |
test-module | Undo an inadvertant revert from template changes so we still allow pythonic imports in module land. | 11 years ago |
README.md
'Hacking' directory tools
Env-setup
The 'env-setup' script modifies your environment to allow you to run ansible from a git checkout using python 2.6+. (You may not use python 3 at this time).
First, set up your environment to run from the checkout:
$ source ./hacking/env-setup
You will need some basic prerequisites installed. If you do not already have them and do not wish to install them from your operating system package manager, you can install them from pip
$ easy_install pip # if pip is not already available
$ pip install pyyaml jinja2
From there, follow ansible instructions on ansibleworks.com/docs as normal.
Test-module
'test-module' is a simple program that allows module developers (or testers) to run a module outside of the ansible program, locally, on the current machine.
Example:
$ ./hacking/test-module -m library/commands/shell -a "echo hi"
This is a good way to insert a breakpoint into a module, for instance.
Module-formatter
The module formatter is a script used to generate manpages and online module documentation. This is used by the system makefiles and rarely needs to be run directly.
Authors
'authors' is a simple script that generates a list of everyone who has contributed code to the ansible repository.