From 3f4808987489e4b33e14a3112efa78f1eb899ad0 Mon Sep 17 00:00:00 2001 From: Alberto Escolar Piedras Date: Tue, 13 Aug 2024 10:28:07 +0200 Subject: [PATCH] docs: api_lifecycle: Change where to list deprecated items 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 --- doc/develop/api/api_lifecycle.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/develop/api/api_lifecycle.rst b/doc/develop/api/api_lifecycle.rst index 112c9d3722e8..2923451aa020 100644 --- a/doc/develop/api/api_lifecycle.rst +++ b/doc/develop/api/api_lifecycle.rst @@ -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 `_ + 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