patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 7 Packages Projects Releases Wiki Activity

doc: api: Formulate a procedure to declare an API stable

Browse source 
Lay out the steps required to declare an API stable.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2020-03-18 17:28:26 +01:00 committed by Carles Cufí
parent b6ee5fca8e
commit b87629589e
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/development_process/api_lifecycle.rst
View file

@ -84,6 +84,16 @@ An API can be declared ``stable`` after fulfilling the following requirements:
- Stable APIs can get backward compatible updates, bug fixes and security fixes
at any time.
In order to declare an API ``stable``, the following steps need to be followed:
#. A Pull Request must be opened that changes the corresponding entry in the
:ref:`api_stability` table
#. An email must be sent to the ``devel`` mailing list announcing the API
upgrade request
#. The Pull Request must be submitted for discussion in the next
`Zephyr API meeting`_ where, barring any objections, the Pull Request will be
merged
.. _stable_api_changes:
Introducing incompatible changes