From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 838FC5A32 for ; Tue, 21 Jul 2015 15:20:03 +0200 (CEST) Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga103.fm.intel.com with ESMTP; 21 Jul 2015 06:20:02 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.15,516,1432623600"; d="scan'208";a="766660344" Received: from irsmsx153.ger.corp.intel.com ([163.33.192.75]) by fmsmga002.fm.intel.com with ESMTP; 21 Jul 2015 06:20:01 -0700 Received: from irsmsx108.ger.corp.intel.com ([169.254.11.201]) by IRSMSX153.ger.corp.intel.com ([169.254.9.140]) with mapi id 14.03.0224.002; Tue, 21 Jul 2015 14:20:00 +0100 From: "Dumitrescu, Cristian" To: Thomas Monjalon , "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH 1/4] doc: rename ABI chapter to deprecation Thread-Index: AQHQwhE3igL7McJri0CeKRLqxFFNn53l6pNQ Date: Tue, 21 Jul 2015 13:20:00 +0000 Message-ID: <3EB4FA525960D640B5BDFFD6A3D891263239F168@IRSMSX108.ger.corp.intel.com> References: <1437303137-29430-1-git-send-email-thomas.monjalon@6wind.com> <1437303137-29430-2-git-send-email-thomas.monjalon@6wind.com> In-Reply-To: <1437303137-29430-2-git-send-email-thomas.monjalon@6wind.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [163.33.239.181] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH 1/4] doc: rename ABI chapter to deprecation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 21 Jul 2015 13:20:04 -0000 > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Thomas Monjalon > Sent: Sunday, July 19, 2015 11:52 AM > To: dev@dpdk.org > Subject: [dpdk-dev] [PATCH 1/4] doc: rename ABI chapter to deprecation >=20 > This chapter is for ABI and API. That's why a renaming is required. >=20 > Remove also the examples which are now in the referenced guidelines. >=20 > Signed-off-by: Thomas Monjalon > --- > MAINTAINERS | 2 +- > doc/guides/rel_notes/{abi.rst =3D> deprecation.rst} | 16 +++++----------= - > doc/guides/rel_notes/index.rst | 2 +- > 3 files changed, 7 insertions(+), 13 deletions(-) > rename doc/guides/rel_notes/{abi.rst =3D> deprecation.rst} (51%) >=20 > diff --git a/MAINTAINERS b/MAINTAINERS > index 2a32659..6531900 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -60,7 +60,7 @@ F: doc/guides/prog_guide/ext_app_lib_make_help.rst > ABI versioning > M: Neil Horman > F: lib/librte_compat/ > -F: doc/guides/rel_notes/abi.rst > +F: doc/guides/rel_notes/deprecation.rst > F: scripts/validate-abi.sh >=20 >=20 > diff --git a/doc/guides/rel_notes/abi.rst > b/doc/guides/rel_notes/deprecation.rst > similarity index 51% > rename from doc/guides/rel_notes/abi.rst > rename to doc/guides/rel_notes/deprecation.rst > index 7a08830..eef01f1 100644 > --- a/doc/guides/rel_notes/abi.rst > +++ b/doc/guides/rel_notes/deprecation.rst > @@ -1,17 +1,11 @@ > -ABI policy > -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > +Deprecation > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D >=20 > See the :doc:`guidelines document for details of the ABI policy > `. > -ABI deprecation notices are to be posted here. > +API and ABI deprecation notices are to be posted here. >=20 > - > -Examples of Deprecation Notices > -------------------------------- > - > -* The Macro #RTE_FOO is deprecated and will be removed with version 2.0, > to be replaced with the inline function rte_bar() > -* The function rte_mbuf_grok has been updated to include new parameter > in version 2.0. Backwards compatibility will be maintained for this func= tion > until the release of version 2.1 > -* The members struct foo have been reorganized in release 2.0. Existing > binary applications will have backwards compatibility in release 2.0, whi= le > newly built binaries will need to reference new structure variant struct = foo2. > Compatibility will be removed in release 2.2, and all applications will r= equire > updating and rebuilding to the new structure at that time, which will be > renamed to the original struct foo. > -* Significant ABI changes are planned for the librte_dostuff library. T= he > upcoming release 2.0 will not contain these changes, but release 2.1 will= , and > no backwards compatibility is planned due to the invasive nature of these > changes. Binaries using this library built prior to version 2.1 will req= uire > updating and recompilation. > +Help to update from a previous release is provided in > +:doc:`another section `. >=20 >=20 > Deprecation Notices > diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.= rst > index d790783..9d66cd8 100644 > --- a/doc/guides/rel_notes/index.rst > +++ b/doc/guides/rel_notes/index.rst > @@ -48,5 +48,5 @@ Contents > updating_apps > known_issues > resolved_issues > - abi > + deprecation > faq > -- > 2.4.2 Hi Thomas, There are some pending doc patches on ABI changes that have been sent and a= ck-ed prior to this change. Due to this change, they cannot be applied cleanly anymore. Are you OK to i= ntegrate them with the small local change required from your side? Thanks, Cristian