Skip to content

Commit

Permalink
docs: api_lifecycle: Change where to list deprecated items
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
aescolar committed Aug 15, 2024
1 parent e7b267d commit 3f48089
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions doc/develop/api/api_lifecycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
API
- The change needs to be atomic and bisectable
- Create a GitHub issue to track the removal of the deprecated API, and
add it to the roadmap targeting the appropriate release
(in the example above, 1.16).
- Add an entry in the corresponding release
`GitHub issue <https://github.com/zephyrproject-rtos/zephyr/labels/deprecation_tracker>`_
tracking removal of deprecated APIs.

During the deprecation waiting period, the API will be in the ``deprecated``
state. The Zephyr maintainers will track usage of deprecated APIs on
Expand Down

0 comments on commit 3f48089

Please sign in to comment.