From b87629589ec690a383bd0eee99c6bdf9f5382fd9 Mon Sep 17 00:00:00 2001 From: Carles Cufi Date: Wed, 18 Mar 2020 17:28:26 +0100 Subject: [PATCH] doc: api: Formulate a procedure to declare an API stable Lay out the steps required to declare an API stable. Signed-off-by: Carles Cufi --- doc/development_process/api_lifecycle.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/development_process/api_lifecycle.rst b/doc/development_process/api_lifecycle.rst index 9d9e4dd0b08..f047ede9c05 100644 --- a/doc/development_process/api_lifecycle.rst +++ b/doc/development_process/api_lifecycle.rst @@ -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