From mboxrd@z Thu Jan 1 00:00:00 1970 From: Ferruh Yigit Subject: [PATCH v4 3/3] doc: add deprecation marker usage Date: Thu, 24 Jan 2019 18:10:19 +0000 Message-ID: <20190124181019.17168-3-ferruh.yigit@intel.com> References: <20190122162310.53613-1-ferruh.yigit@intel.com> <20190124181019.17168-1-ferruh.yigit@intel.com> Cc: Luca Boccassi , Kevin Traynor , Yongseok Koh , Neil Horman To: dev@dpdk.org, John McNamara , Marko Kovacevic Return-path: Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by dpdk.org (Postfix) with ESMTP id 58A8E5F1B for ; Thu, 24 Jan 2019 19:10:33 +0100 (CET) In-Reply-To: <20190124181019.17168-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 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 --- Cc: Luca Boccassi Cc: Kevin Traynor Cc: Yongseok Koh Cc: Neil Horman v2: * Rephrased as commented v3: * changed when to remove the deprecated API. It is now just after an LTS release, the motivation is to keep changes small in LTS. Based on techboard discussion: http://mails.dpdk.org/archives/dev/2019-January/123519.html v4: change working around 'active': s/active/non-experimental/ s/become active/be able to replace old API --- 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 bfc27fbe0..491fae438 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 removed completely just after the next LTS. + +Reminder that new API should follow deprecation process to be able to replace old API. + Experimental APIs ----------------- -- 2.17.2