ansible/hacking
2013-12-30 14:53:32 -06:00
..
templates include short_description in the module page's title 2013-12-26 14:35:57 -05:00
authors.sh fixed x-bits in git 2013-06-16 22:22:16 -04:00
env-setup env-setup fix for zsh <= 4.3.10 2013-12-04 14:36:47 +01:00
env-setup.fish Fixed usage comment to fish syntax for sourcing a file 2013-08-14 15:52:37 -06:00
module_formatter.py Add note about how to submit doc changes to generated module docs, limit TOC depth for module category list. 2013-12-25 21:29:54 -05:00
README.md Fix module path in readme file. 2013-07-19 09:34:43 -04:00
test-module Add -I/--interpreter argument to test-module 2013-12-30 14:53:32 -06:00

'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.