[dpdk-dev] [RFC 2/2] doc: add deprecation marker usage

[Ferruh Yigit]

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 at intel.com>
>> ---
>> Cc: Luca Boccassi <bluca at debian.org>
>> Cc: Kevin Traynor <ktraynor at redhat.com>
>> Cc: Yongseok Koh <yskoh at mellanox.com>
>> Cc: Neil Horman <nhorman at 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 at debian.org>
>