You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/hacking
Brian Coca 3c4afd0470 Doc module meta (#20093)
* updated module docs to reflect unification/meta

* new doc page

* also remove module refs to old core/extra

* Update modules_support.rst

Light edit.
8 years ago
..
templates Doc module meta (#20093) 8 years ago
tests gen_distribution_version_testcase.py should fail if ansible run fails (#17693) 8 years ago
README.md Update the module path from the hacking documentation (#19683) 8 years ago
authors.sh removed merges from count 9 years ago
cherrypick.py Whitelist the hacking/cherrypick script's use of python3 8 years ago
dump_playbook_attributes.py Fix compile errors in scripts. 8 years ago
env-setup Add detection of python3 to hacking/env-setup (#17357) 8 years ago
env-setup.fish Fish hacking setup fix (#18084) 8 years ago
get_library.py Change to python3 syntax 9 years ago
metadata-tool.py Additional reports (#18779) 8 years ago
module_formatter.py quick and dirty module doc updates (#18944) 8 years ago
test-module test-module _ansible_selinux_special_fs arg added 8 years ago
update.sh Move update.sh to hacking repository ,see #10081 10 years ago
update_bundled.py Clean up shebangs for various files. 8 years ago
yamlcheck.py Clean up shebangs for various files. 8 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 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/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.