From: Lou Berger Date: Thu, 29 Mar 2018 22:50:30 +0000 (-0400) Subject: doc: add note on use of scripts to enable immediate removale deprecated APIs/macros X-Git-Tag: frr-5.0-dev~96^2 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=refs%2Fpull%2F1984%2Fhead;p=mirror%2Ffrr.git doc: add note on use of scripts to enable immediate removale deprecated APIs/macros Signed-off-by: Lou Berger --- diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 0114a6ddbd..80029cbd1c 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -702,6 +702,13 @@ 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. +Preferably, the shell script :file:`tools/fixup-deprecated.py` will be +updated along with making non-backwards compatible code changes, or an +alternate script should be introduced, to update the code to match the +change. When the script is updated, there is no need to preserve the +deprecated code. Note that this does not apply to user interface +changes, just internal code, macros and libraries. + Miscellaneous -------------