[v2,2/2] doc: add deprecation marker usage
Checks
Commit Message
Define '__rte_deprecated' usage process.
Suggests keeping old API with '__rte_deprecated' marker until next LTS.
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Luca Boccassi <bluca@debian.org>
---
Cc: Luca Boccassi <bluca@debian.org>
Cc: Kevin Traynor <ktraynor@redhat.com>
Cc: Yongseok Koh <yskoh@mellanox.com>
Cc: Neil Horman <nhorman@tuxdriver.com>
v2:
* Rephrased as commented
---
doc/guides/contributing/versioning.rst | 10 ++++++++++
1 file changed, 10 insertions(+)
@@ -128,6 +128,16 @@ added to the Release Notes:
these changes. Binaries using this library built prior to version 2.1 will
require updating and recompilation.
+New API replacing previous one
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If a new API proposed functionally replaces an existing one, when the
+new API becomes active then the old one is marked with
+``__rte_deprecated`` until the next LTS. In the next LTS, the API is
+removed completely.
+
+Reminder that new API should follow deprecation process to become active.
+
Experimental APIs
-----------------