ansible/hacking
Matt Davis ec2cb07988 Make 'required' optional in module docs (#15906)
Updated module dev docs, doc build, ansible-doc to match
2016-05-18 16:57:36 -07:00
..
templates fixed typo 2016-02-29 17:52:55 -05:00
tests Dist version fix for Red Hat and more tests (#15663) 2016-04-29 13:18:50 -07:00
authors.sh
dump_playbook_attributes.py avoid private attributes 2016-03-10 01:00:33 -05:00
env-setup Replace -delete with portable -exec rm {} \; 2015-12-02 11:06:09 +01:00
env-setup.fish Make -q flag totally quiet for env-setup.fish 2016-04-27 11:34:51 -07:00
get_library.py
module_formatter.py Make 'required' optional in module docs (#15906) 2016-05-18 16:57:36 -07:00
README.md
test-module Remove the duplicate modstyle parameter 2016-04-27 10:04:16 -07:00
update.sh
update_bundled.py
yamlcheck.py quick yaml syntax checker 2016-05-18 18:15:12 -04: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 nose passlib pycrypto

From there, follow ansible instructions on docs.ansible.com 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 lib/ansible/modules/core/commands/shell -a "echo hi"

This is a good way to insert a breakpoint into a module, for instance.

For more complex arguments such as the following yaml:

parent:
  child:
    - item: first
      val: foo
    - item: second
      val: boo

Use:

$ ./hacking/test-module -m module \
    -a "{"parent": {"child": [{"item": "first", "val": "foo"}, {"item": "second", "val": "bar"}]}}"

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.