ansible/lib/ansible/cli
John R Barker a23c95023b
Module deprecation: docs, scheme and tests (#34100)
Enforce module deprecation.
After module has reached the end of it's deprecation cycle we will replace it with a docs stub.

* Replace deprecated modules with docs-only sub
* Use of deprecated past deprecation cycle gives meaningful message (see examples below)
* Enforce documentation.deprecation dict via `schema.py`
* Update `ansible-doc` and web docs to display documentation.deprecation
* Document that structure in `dev_guide`
* Ensure that all modules starting with `_` have a `deprecation:` block
* Ensure `deprecation:` block is only used on modules that start with `_`
* `removed_in` A string which represents when this module needs **deleting**
* CHANGELOG.md and porting_guide_2.5.rst list removed modules as well as alternatives
* CHANGELOG.md links to porting guide index

To ensure that meaningful messages are given to the user if they try to use a module at the end of it's deprecation cycle we enforce the module to contain:
```python
if __name__ == '__main__':
    removed_module()
```
2018-01-30 12:23:52 +00:00
..
__init__.py add a vault --encrypt-vault-to specify vault id to use for encrypt (#31067) 2018-01-22 17:12:10 -05:00
adhoc.py Fix Python 3.7 syntax error. 2018-01-09 17:34:26 -08:00
config.py ansible-config: add simple tests (#34900) 2018-01-17 06:33:33 -08:00
console.py Temporary (#31677) 2018-01-15 21:15:04 -08:00
doc.py Module deprecation: docs, scheme and tests (#34100) 2018-01-30 12:23:52 +00:00
galaxy.py Add GALAXY_TOKEN config option (#34621) 2018-01-16 07:37:50 -08:00
inventory.py jsonify inventory (#32990) 2017-11-21 13:41:27 -08:00
playbook.py dont warn on not matching 'all' (#32806) 2017-12-15 15:43:51 -05:00
pull.py add support for other scms to pull (#33152) 2017-12-13 22:16:54 -05:00
vault.py add a vault --encrypt-vault-to specify vault id to use for encrypt (#31067) 2018-01-22 17:12:10 -05:00