openstack/python-novaclient
Code Issues Proposed changes

Merge "Update docs for instructions on deprecating commands"

Browse Source
This commit is contained in:
Jenkins 2016-10-19 10:22:26 +00:00 committed by Gerrit Code Review
commit bd636c8698
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/index.rst
View File

@ -59,8 +59,10 @@ The process for command deprecation is:
deprecated command is used.
- That warning message should include a rough timeline for when the command
will be removed and what should be used instead, if anything.
- The commit message on the change should include a DocImpact tag so it
gets in the release notes.
- The description in the help text for the deprecated command should mark
that it is deprecated.
- The change should include a release note with the ``deprecations`` section
filled out.
- The deprecation cycle is typically the first client release *after* the
next *full* Nova server release so that there is at least six months of
deprecation.