From mboxrd@z Thu Jan  1 00:00:00 1970
From: Luca Boccassi <bluca@debian.org>
Subject: Re: [RFC 2/2] doc: add deprecation marker usage
Date: Thu, 20 Dec 2018 09:02:08 +0100
Message-ID: <1545292928.9718.10.camel@debian.org>
References: <20181219125253.77398-1-ferruh.yigit@intel.com>
 <20181219125253.77398-2-ferruh.yigit@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Cc: Kevin Traynor <ktraynor@redhat.com>, Yongseok Koh <yskoh@mellanox.com>,
 Neil Horman <nhorman@tuxdriver.com>
To: Ferruh Yigit <ferruh.yigit@intel.com>, dev@dpdk.org, John McNamara
 <john.mcnamara@intel.com>, Marko Kovacevic <marko.kovacevic@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from mail-wr1-f68.google.com (mail-wr1-f68.google.com
 [209.85.221.68]) by dpdk.org (Postfix) with ESMTP id C0D67683E
 for <dev@dpdk.org>; Thu, 20 Dec 2018 09:02:31 +0100 (CET)
Received: by mail-wr1-f68.google.com with SMTP id q18so680129wrx.9
 for <dev@dpdk.org>; Thu, 20 Dec 2018 00:02:31 -0800 (PST)
In-Reply-To: <20181219125253.77398-2-ferruh.yigit@intel.com>
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 Wed, 2018-12-19 at 12:52 +0000, Ferruh Yigit wrote:
> Define '__rte_deprecated' usage process.
>=20
> Suggests keeping old API with '__rte_deprecated' marker until next
> LTS.
>=20
> 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>
> ---
> =C2=A0doc/guides/contributing/versioning.rst | 9 +++++++++
> =C2=A01 file changed, 9 insertions(+)
>=20
> 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:
> =C2=A0=C2=A0=C2=A0these changes. Binaries using this library built prior =
to version
> 2.1 will
> =C2=A0=C2=A0=C2=A0require updating and recompilation.
> =C2=A0
> +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."

Other than that:

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

--=20
Kind regards,
Luca Boccassi