From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id 908654C90 for ; Fri, 1 Mar 2019 18:33:01 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 01 Mar 2019 09:33:01 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,428,1544515200"; d="scan'208";a="138302605" Received: from silpixa00399752.ir.intel.com (HELO silpixa00399752.ger.corp.intel.com) ([10.237.222.212]) by orsmga002.jf.intel.com with ESMTP; 01 Mar 2019 09:32:59 -0800 From: Ferruh Yigit To: dev@dpdk.org, John McNamara , Marko Kovacevic Cc: Luca Boccassi , Neil Horman , Kevin Traynor , Yongseok Koh Date: Fri, 1 Mar 2019 17:32:50 +0000 Message-Id: <20190301173250.80930-3-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190301173250.80930-1-ferruh.yigit@intel.com> References: <20190124181019.17168-1-ferruh.yigit@intel.com> <20190301173250.80930-1-ferruh.yigit@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v5 3/3] doc: add deprecation marker usage X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 01 Mar 2019 17:33:02 -0000 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 v5: Grammar fix Rephrase API removal reminder --- 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 2fcb8bafd..30f8735ba 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 ----------------- -- 2.20.1