michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: api_lifecycle: Use DEPRECATED instead of LEGACY in Kconfig

Browse source 
Recommend that Kconfig symbols related to deprecated features use
'DEPRECATED' in the symbol name instead of 'LEGACY'.

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
This commit is contained in:
Kumar Gala 2020-06-08 08:41:14 -05:00 • committed by Carles Cufí
commit 6e9d109922
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/development_process/api_lifecycle.rst
View file

@ -201,7 +201,7 @@ The following are the requirements for deprecating an existing API:
- Mark as deprecated. This can be done by using the compiler itself
(``__deprecated`` for function declarations and ``__DEPRECATED_MACRO`` for
macro definitions), or by introducing a Kconfig option (typically one that
contains the ``LEGACY`` word in it) that, when enabled, reverts the APIs
contains the ``DEPRECATED`` word in it) that, when enabled, reverts the APIs
back to their previous form
- Document the deprecation
- Include the deprecation in the "API Changes" of the release notes for the