michaelh/zephyr
1
0
Fork 0
Code Releases Activity

docs: api_lifecycle: Change where to list deprecated items

Browse source 
When deprecating APIs,
let's tell users to add to one GitHub issue tracking all
deprecated APIs meant to be removed,
so the process is simpler and hopefully developers do it.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
This commit is contained in:
Alberto Escolar Piedras 2024-08-13 10:28:07 +02:00 • committed by Alberto Escolar
commit 3f48089874
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/develop/api/api_lifecycle.rst
View file

@ -236,9 +236,9 @@ The following are the requirements for deprecating an existing API:
- Code using the deprecated API needs to be modified to remove usage of said - Code using the deprecated API needs to be modified to remove usage of said
API API
- The change needs to be atomic and bisectable - The change needs to be atomic and bisectable
- Create a GitHub issue to track the removal of the deprecated API, and - Add an entry in the corresponding release
add it to the roadmap targeting the appropriate release `GitHub issue <https://github.com/zephyrproject-rtos/zephyr/labels/deprecation_tracker>`_
(in the example above, 1.16). tracking removal of deprecated APIs.
During the deprecation waiting period, the API will be in the ``deprecated`` During the deprecation waiting period, the API will be in the ``deprecated``
state. The Zephyr maintainers will track usage of deprecated APIs on state. The Zephyr maintainers will track usage of deprecated APIs on