]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: add note on use of scripts to enable immediate removale deprecated APIs/macros 1984/head
authorLou Berger <lberger@labn.net>
Thu, 29 Mar 2018 22:50:30 +0000 (18:50 -0400)
committerDonald Sharp <sharpd@cumulusnetworks.com>
Fri, 30 Mar 2018 16:13:54 +0000 (12:13 -0400)
Signed-off-by: Lou Berger <lberger@labn.net>
doc/developer/workflow.rst

index 0114a6ddbd04dad8d87be0e28ed9243b6b1331c8..80029cbd1c27686447a5df0d830fc0c227f566a9 100644 (file)
@@ -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
 -------------