From: Ferruh Yigit Date: Fri, 1 Mar 2019 17:32:50 +0000 (+0000) Subject: doc: add deprecation marker usage X-Git-Url: http://git.droids-corp.org/?p=dpdk.git;a=commitdiff_plain;h=7abe4a24cc3f0ff011599e2783590564fdff59eb 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 Acked-by: Luca Boccassi Acked-by: Neil Horman Acked-by: Kevin Traynor --- diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst index 74c73c2320..988c1f628e 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 -----------------