From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) by dpdk.org (Postfix) with ESMTP id 646A84C6C for ; Fri, 1 Mar 2019 18:41:17 +0100 (CET) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id AF2E8C0B2C6C; Fri, 1 Mar 2019 17:41:11 +0000 (UTC) Received: from [10.72.12.72] (ovpn-12-72.pek2.redhat.com [10.72.12.72]) by smtp.corp.redhat.com (Postfix) with ESMTP id A660E60144; Fri, 1 Mar 2019 17:40:58 +0000 (UTC) To: Ferruh Yigit , dev@dpdk.org, John McNamara , Marko Kovacevic Cc: Luca Boccassi , Neil Horman , Yongseok Koh References: <20190124181019.17168-1-ferruh.yigit@intel.com> <20190301173250.80930-1-ferruh.yigit@intel.com> <20190301173250.80930-3-ferruh.yigit@intel.com> From: Kevin Traynor Message-ID: Date: Fri, 1 Mar 2019 17:40:54 +0000 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.5.1 MIME-Version: 1.0 In-Reply-To: <20190301173250.80930-3-ferruh.yigit@intel.com> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.31]); Fri, 01 Mar 2019 17:41:16 +0000 (UTC) Subject: Re: [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:41:17 -0000 On 01/03/2019 17:32, Ferruh Yigit wrote: > 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 > ----------------- > Acked-by: Kevin Traynor for series, again :-)