diff options
| author | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-09-17 16:48:11 +0000 |
|---|---|---|
| committer | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-09-17 16:48:11 +0000 |
| commit | e12ea4bb861fa4abca11da04a896ab2d41bf98bf (patch) | |
| tree | cc394a6673639e9734fa89fbb855d3bcd00f9f14 | |
| parent | b4657ea44c7853047fa21585defd06b4b2e52752 (diff) | |
doc: document CLI deprecation period length
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
| -rw-r--r-- | doc/developer/workflow.rst | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index d316de0f38..ee7592fd6a 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -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 |