From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ferruh Yigit Subject: [PATCH v2 2/2] doc: add deprecation marker usage Date: Fri, 21 Dec 2018 15:57:19 +0000 Message-ID: <20181221155719.89773-2-ferruh.yigit@intel.com> References: <20181219125253.77398-1-ferruh.yigit@intel.com> <20181221155719.89773-1-ferruh.yigit@intel.com> Cc: dev@dpdk.org, Luca Boccassi , Kevin Traynor , Yongseok Koh , Neil Horman To: Ferruh Yigit , John McNamara , Marko Kovacevic Return-path: Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 1320A1BE7C for ; Fri, 21 Dec 2018 16:57:27 +0100 (CET) In-Reply-To: <20181221155719.89773-1-ferruh.yigit@intel.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Define '__rte_deprecated' usage process. Suggests keeping old API with '__rte_deprecated' marker until next LTS. Signed-off-by: Ferruh Yigit Acked-by: Luca Boccassi --- Cc: Luca Boccassi Cc: Kevin Traynor Cc: Yongseok Koh Cc: Neil Horman v2: * Rephrased as commented --- doc/guides/contributing/versioning.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst index 19af56cd2..360238985 100644 --- a/doc/guides/contributing/versioning.rst +++ b/doc/guides/contributing/versioning.rst @@ -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 ----------------- -- 2.17.2