michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Rename stable API change to breaking change

Browse source 
It is often confusing for users and developers alike to see the sentence
"stable API change" in a label or in the release notes. Stable APIs can
change in at least two ways (retaining compatibility or not), and so it
is preferrable to use a term that clearly describes the change as
incompatible, by using the common term "breaking".

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2023-12-19 16:35:16 +01:00 • committed by Anas Nashif
commit d053b8bf3b
2 changed files with 15 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/project/dev_env_and_tools.rst
View file

@ -111,7 +111,7 @@ TSC and Working Groups
Changes that introduce new features or functionality or change the way the
overall system works need to be reviewed by the TSC or the responsible Working
Group. For example for :ref:`stable API changes <stable_api_changes>`, the
Group. For example for :ref:`breaking API changes <breaking_api_changes>`, the
proposal needs to be presented in the Architecture meeting so that the relevant
stakeholders are made aware of the change.
@ -383,10 +383,10 @@ following `TSC meeting`_ if time permits.
.. _`TSC meeting`: https://github.com/zephyrproject-rtos/zephyr/wiki/Zephyr-Committee-and-Working-Group-Meetings#technical-steering-committee-tsc
* *Stable API Change*
* *Breaking API Change*
The issue or PR describes a change to a stable API. See additional information
in :ref:`stable_api_changes`.
The issue or PR describes a breaking change to a stable API. See additional information
in :ref:`breaking_api_changes`.
* *Bug*