d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: add deprecation marker usage

Browse Source 
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>
This commit is contained in:
Ferruh Yigit 2019-03-01 17:32:50 +00:00 committed by Thomas Monjalon
parent e17e6d31ca
commit 7abe4a24cc
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/guides/contributing/versioning.rst
View File

@ -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
-----------------