ansible/hacking
Michael DeHaan af9b510769 Merge pull request #3220 from dsedivec/devel
Improve Markdown (and other) module doc output
2013-06-16 19:50:48 -07:00
..
templates Improve Markdown (and other) module doc output 2013-06-14 13:27:59 -05:00
authors.sh fixed x-bits in git 2013-06-16 22:22:16 -04:00
env-setup Slightly more self-explanatory output for ./hacking/env-setup 2013-03-18 00:27:44 -04:00
module_formatter.py Improve Markdown (and other) module doc output 2013-06-14 13:27:59 -05:00
README.md Restructure hacking readme. 2013-04-20 09:36:09 -04:00
test-module Escape args injected in new style modules 2013-05-24 01:01:07 +02: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 ansible.cc/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/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.