doc: add note on use of scripts to enable immediate removale deprecated APIs/macros

Signed-off-by: Lou Berger <lberger@labn.net>
This commit is contained in:
Lou Berger 2018-03-29 18:50:30 -04:00 committed by Donald Sharp
parent 047460795c
commit cab3f81198

View 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
-------------