From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 371A71B92F for ; Wed, 19 Dec 2018 13:53:04 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 19 Dec 2018 04:53:03 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.56,372,1539673200"; d="scan'208";a="305083092" Received: from silpixa00399752.ir.intel.com (HELO silpixa00399752.ger.corp.intel.com) ([10.237.222.212]) by fmsmga005.fm.intel.com with ESMTP; 19 Dec 2018 04:53:01 -0800 From: Ferruh Yigit To: dev@dpdk.org, John McNamara , Marko Kovacevic Cc: Ferruh Yigit , Luca Boccassi , Kevin Traynor , Yongseok Koh , Neil Horman Date: Wed, 19 Dec 2018 12:52:53 +0000 Message-Id: <20181219125253.77398-2-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.17.2 In-Reply-To: <20181219125253.77398-1-ferruh.yigit@intel.com> References: <20181219125253.77398-1-ferruh.yigit@intel.com> Subject: [dpdk-dev] [RFC 2/2] 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: Wed, 19 Dec 2018 12:53:04 -0000 Define '__rte_deprecated' usage process. Suggests keeping old API with '__rte_deprecated' marker until next LTS. Signed-off-by: Ferruh Yigit --- Cc: Luca Boccassi Cc: Kevin Traynor Cc: Yongseok Koh Cc: Neil Horman --- 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 19af56cd2..e0edd2e20 100644 --- a/doc/guides/contributing/versioning.rst +++ b/doc/guides/contributing/versioning.rst @@ -128,6 +128,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 new API becomes +active old one marked with ``__rte_deprecated`` until next LTS. In next LTS API +removed completely. + +Reminder that new API should follow deprecation process to become active. + Experimental APIs ----------------- -- 2.17.2