Closed bcoca closed 6 years ago
Links to things that will need updating
grep '\.deprecat'
Needs to work for suboptions
Discussed in Core meeting 1st June 2017
The above also believe that the module level deprecations should move to using this
Docs also need updating to point out how to deprecate options in argspec
Once merged the the following modules will need updating to make use of it:
Feel free to edit this comment to add other modules to the list
Discussed in Core meeting *st June 2017 +1 from Core thaumos ryansb jctanner gundalow, sivel, shertel +1 from community: dminca
RESULT: Agreed
bcoca may do this as part of the Ansible config project
released in 2.4: infrastructure to support it and started using in plugins and config definitions/entries, new module deprecation should use the new format.
Proposal: deprecated doc key for options
Author: Brian Coca <@bcoca> IRC: bcoca
Date: 2017/06/-1
Motivation
There is no way to document the deprecation of an option in plugins.
Problems
Will allow authors to document deprecation of options.
Solution proposal
A
deprecated
key that is composed of the following:Dependencies (optional)
Doc validator needs to permit