doc: document CLI deprecation period length

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
This commit is contained in:
Quentin Young 2018-09-17 16:48:11 +00:00
parent b4657ea44c
commit e12ea4bb86

View File

@ -778,6 +778,8 @@ That said, compatibility measures can (and should) be removed when either:
- some measure of time (dependent on the specific case) has passed, so that
the compatibility grace period is considered expired.
For CLI commands, the deprecation period is 1 year.
In all cases, compatibility pieces should be marked with compiler/preprocessor
annotations to print warnings at compile time, pointing to the appropriate
update path. A ``-Werror`` build should fail if compatibility bits are used. To