summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFerruh Yigit <ferruh.yigit@intel.com>2019-03-01 17:32:50 +0000
committerThomas Monjalon <thomas@monjalon.net>2019-03-27 14:28:51 +0100
commit7abe4a24cc3f0ff011599e2783590564fdff59eb (patch)
tree1d99dc5f208cea3a0fe3745a72d069e1dd13b6c3 /doc
parente17e6d31ca66d977a6a212b1c612c9b8f2cc166b (diff)
downloaddpdk-next-eventdev-7abe4a24cc3f0ff011599e2783590564fdff59eb.zip
dpdk-next-eventdev-7abe4a24cc3f0ff011599e2783590564fdff59eb.tar.gz
dpdk-next-eventdev-7abe4a24cc3f0ff011599e2783590564fdff59eb.tar.xz
doc: add deprecation marker usage
Define '__rte_deprecated' usage process. Suggests keeping old API with '__rte_deprecated' marker including next LTS, they will be removed just after the LTS release. Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com> Acked-by: Luca Boccassi <bluca@debian.org> Acked-by: Neil Horman <nhorman@tuxdriver.com> Acked-by: Kevin Traynor <ktraynor@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/guides/contributing/versioning.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst
index 74c73c2..988c1f6 100644
--- a/doc/guides/contributing/versioning.rst
+++ b/doc/guides/contributing/versioning.rst
@@ -125,6 +125,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 the new API
+becomes non-experimental then the old one is marked with ``__rte_deprecated``.
+Deprecated APIs are removed completely just after the next LTS.
+
+Reminder that old API should follow deprecation process to be removed.
+
Experimental APIs
-----------------