[dpdk-dev] [RFC 2/2] doc: add deprecation marker usage

Ferruh Yigit ferruh.yigit at intel.com
Wed Dec 19 13:52:53 CET 2018

Define '__rte_deprecated' usage process.

Suggests keeping old API with '__rte_deprecated' marker until next LTS.

Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>
Cc: Luca Boccassi <bluca at debian.org>
Cc: Kevin Traynor <ktraynor at redhat.com>
Cc: Yongseok Koh <yskoh at mellanox.com>
Cc: Neil Horman <nhorman at tuxdriver.com>
 doc/guides/contributing/versioning.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst
index 19af56cd2..e0edd2e20 100644
--- a/doc/guides/contributing/versioning.rst
+++ b/doc/guides/contributing/versioning.rst
@@ -128,6 +128,15 @@ 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 new API becomes
+active old one marked with ``__rte_deprecated`` until next LTS. In next LTS API
+removed completely.
+Reminder that new API should follow deprecation process to become active.
 Experimental APIs

More information about the dev mailing list