History

Brian Coca 7839f70e36 Enable documentation in plugins Made ansible-doc more plugin agnostic We can have docs in lookup, callback, connectionm strategy, etc Use first docstring and make pepizis happy generalized module_docs to plugin_docs documented cartesian, ssh, default, jsonfile, etc as examples changed lack of docs to warning when listing made smarter about bad docstrings better blacklisting added handling of options/config/envs/etc move blacklist to find_plugins, only need once		2017-03-23 01:27:19 -04:00
..
templates	Doc directives (#22524 )	2017-03-15 11:29:58 -04:00
tests	PEP 8 indent cleanup. (#20800 )	2017-01-29 07:28:53 +00:00
authors.sh
cherrypick.py	Whitelist the hacking/cherrypick script's use of python3	2017-01-05 10:20:58 -08:00
dump_playbook_attributes.py	minor doc gen fixes	2017-03-20 15:47:24 -04:00
env-setup	Add `test/runner` to $PATH in `hacking/env-setup`. (#22387 )	2017-03-07 16:31:53 -08:00
env-setup.fish
get_library.py
metadata-tool.py	New metadata 1.0 (#22587 )	2017-03-14 09:07:22 -07:00
module_formatter.py	Enable documentation in plugins	2017-03-23 01:27:19 -04:00
README.md	Switch tests to pytest and ansible-test.	2017-01-11 12:34:59 -08:00
test-module	Update test-module (#20737 )	2017-01-31 20:05:53 -08:00
update.sh
update_bundled.py
yamlcheck.py

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 nose pytest 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/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.