cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

added info about new deprecated/alias plugin loading

Browse source
This commit is contained in:
Brian Coca 2014-10-28 08:43:18 -07:00
parent 5ab4467708
commit 617b6323e2
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docsite/rst/developing_modules.rst
View file

@ -465,6 +465,23 @@ a github pull request to the `extras <https://github.com/ansible/ansible-modules
Included modules will ship with ansible, and also have a change to be promoted to 'core' status, which Included modules will ship with ansible, and also have a change to be promoted to 'core' status, which
gives them slightly higher development priority (though they'll work in exactly the same way). gives them slightly higher development priority (though they'll work in exactly the same way).
Deprecating and makingm module aliases
``````````````````````````````````````
Starting in 1.8 you can deprecate modules by renaming them with a preceeding _, i.e. old_cloud.py to
_old_cloud.py, This will keep the module available but hide it from the primary docs and listing.
You can also rename modules and keep an alias to the old name by using a symlink that starts with _.
This example allows the stat module to be called with fileinfo, making the following examples equivalent
EXAMPLES = '''
ln -s stat.py _fileinfo.py
ansible -m stat -a "path=/tmp" localhost
ansible -m fileinfo -a "path=/tmp" localhost
'''
.. seealso:: .. seealso::
:doc:`modules` :doc:`modules`