From 2a622fff471d64736106359487bb56e50bf3afa4 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Wed, 12 Oct 2016 18:24:01 -0400 Subject: [PATCH] Update docs for instructions on deprecating commands The instructions for deprecating commands predated reno so this change updates them a bit to be current with our processes now. Also adds a reminder to update the help text/description of a command to mark it deprecated. Change-Id: I530399ba9cf6c50bd0dbb06f231aee61466eebd6 --- doc/source/index.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index bdbce90c4..2e40292a0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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.