Skip to content

Commit 52f6f6b

Browse files
aescolarnashif
authored andcommitted
doc: API lifecycle: Require creating a issue to track removal
As discussed in the TSC meeting of 2019/03/27: To ensure that we do not forget to remove an API 2 releases later and to provide a bit better visibility about when the removal is planned, require that a GH issue be created, and that this issue be added to the roadmap for the apropriate release. As a free bonus: Removed a redundant line in the list and added one missing article. Signed-off-by: Alberto Escolar Piedras <[email protected]>
1 parent c240b69 commit 52f6f6b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

doc/development_process/api_lifecycle.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,10 +100,12 @@ The following are the requirements for deprecating an existing API:
100100

101101
- Mark as deprecated
102102
- Document the deprecation
103-
- All usage in Zephyr for deprecated API needs to be modified
104-
- Change needs to be atomic and bisectable
105103
- Code using the deprecated API needs to be modified to remove usage of said
106104
API
105+
- The change needs to be atomic and bisectable
106+
- Create a GitHub issue to track the removal of the deprecated API, and
107+
add it to the roadmap targeting the appropriate release
108+
(in the example above, 1.16).
107109

108110
During the deprecation waiting period, the API will be in the ``deprecated``
109111
state. The Zephyr maintainers will track usage of deprecated APIs on
@@ -130,5 +132,6 @@ the corresponding documentation, and communicate the removal in the usual ways:
130132
the release notes, mailing lists, Github issues and pull-requests.
131133

132134
If it's not OK to remove the API, the maintainers will continue to support
133-
migration and aim to remove the API in the next release.
135+
migration and update the roadmap with the aim to remove the API in the next
136+
release.
134137

0 commit comments

Comments
 (0)