From mboxrd@z Thu Jan  1 00:00:00 1970
From: Ferruh Yigit <ferruh.yigit@intel.com>
Subject: Re: [RFC 2/2] doc: add deprecation marker usage
Date: Fri, 21 Dec 2018 15:52:49 +0000
Message-ID: <185d99ee-8045-15d5-91b3-5ac17670f5ba@intel.com>
References: <20181219125253.77398-1-ferruh.yigit@intel.com>
 <20181219125253.77398-2-ferruh.yigit@intel.com>
 <1545292928.9718.10.camel@debian.org>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
Cc: Kevin Traynor <ktraynor@redhat.com>, Yongseok Koh <yskoh@mellanox.com>,
 Neil Horman <nhorman@tuxdriver.com>
To: Luca Boccassi <bluca@debian.org>, dev@dpdk.org,
 John McNamara <john.mcnamara@intel.com>,
 Marko Kovacevic <marko.kovacevic@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mga02.intel.com (mga02.intel.com [134.134.136.20])
 by dpdk.org (Postfix) with ESMTP id A2BA21BE42
 for <dev@dpdk.org>; Fri, 21 Dec 2018 16:52:52 +0100 (CET)
In-Reply-To: <1545292928.9718.10.camel@debian.org>
Content-Language: en-US
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

On 12/20/2018 8:02 AM, Luca Boccassi wrote:
> On Wed, 2018-12-19 at 12:52 +0000, Ferruh Yigit wrote:
>> Define '__rte_deprecated' usage process.
>>
>> Suggests keeping old API with '__rte_deprecated' marker until next
>> LTS.
>>
>> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
>> ---
>> Cc: Luca Boccassi <bluca@debian.org>
>> Cc: Kevin Traynor <ktraynor@redhat.com>
>> Cc: Yongseok Koh <yskoh@mellanox.com>
>> Cc: Neil Horman <nhorman@tuxdriver.com>
>> ---
>>  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.
>> +
> 
> Perhaps a bit of rephrasing, ie:
> 
> "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."

Thanks for suggestion, I will send a new version with this update.

> 
> Other than that:
> 
> Acked-by: Luca Boccassi <bluca@debian.org>
>