From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id E46651B2D2 for ; Mon, 6 Nov 2017 15:49:00 +0100 (CET) Received: from orsmga004.jf.intel.com ([10.7.209.38]) by orsmga104.jf.intel.com with ESMTP; 06 Nov 2017 06:49:00 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.44,353,1505804400"; d="scan'208";a="146493670" Received: from irsmsx110.ger.corp.intel.com ([163.33.3.25]) by orsmga004.jf.intel.com with ESMTP; 06 Nov 2017 06:48:59 -0800 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.49]) by irsmsx110.ger.corp.intel.com ([163.33.3.25]) with mapi id 14.03.0319.002; Mon, 6 Nov 2017 14:48:58 +0000 From: "Mcnamara, John" To: "Richardson, Bruce" CC: "dev@dpdk.org" Thread-Topic: [PATCH] doc: update ABI/API policy Thread-Index: AQHTVvVPXH+gkisFd0SSp2yyQlPiWqMHbdSA Date: Mon, 6 Nov 2017 14:48:58 +0000 Message-ID: References: <20171106112806.104289-1-bruce.richardson@intel.com> In-Reply-To: <20171106112806.104289-1-bruce.richardson@intel.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiM2U5YTQ5NjYtNmU1NC00NTRmLWFjMmEtMmIxMDVjYzJjZGZiIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE2LjUuOS4zIiwiVHJ1c3RlZExhYmVsSGFzaCI6IjF5aEt1b0F4OFJzamd0NFNGRWt1MDI3dDhFdlUrclpsbkt6K1pvcjQzMjQ9In0= dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH] doc: update ABI/API policy 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: Mon, 06 Nov 2017 14:49:01 -0000 > -----Original Message----- > From: Richardson, Bruce > Sent: Monday, November 6, 2017 11:28 AM > To: Mcnamara, John > Cc: dev@dpdk.org; Richardson, Bruce > Subject: [PATCH] doc: update ABI/API policy >=20 > Following agreement at the DPDK Technical Board meeting of 2017-10-13 [1]= , > update the documentation with the ABI/API policy changes. >=20 > [1] http://dpdk.org/ml/archives/dev/2017-October/079961.html >=20 > Signed-off-by: Bruce Richardson > --- > doc/guides/contributing/versioning.rst | 19 ++++++++++++++++++- > 1 file changed, 18 insertions(+), 1 deletion(-) >=20 > diff --git a/doc/guides/contributing/versioning.rst > b/doc/guides/contributing/versioning.rst > index 8d0fdb777..a1d8492a1 100644 > --- a/doc/guides/contributing/versioning.rst > +++ b/doc/guides/contributing/versioning.rst > @@ -13,7 +13,9 @@ General Guidelines > ------------------ >=20 > #. Whenever possible, ABI should be preserved -#. The libraries marked i= n > experimental state may change without constraint. > +#. Libraries or APIs marked in ``experimental`` state may change without > constraint. > +#. New API will be marked as ``experimental`` for at least one release t= o s/API/APIs/ > +APIs marked as ``experimental`` are not considered part of the ABI and > +may change without warning at any time. Since changes to APIs are most > +likely immediately after their introduction, as users begin to take > +advantage of those new API and start finding issues with them, new DPDK s/API/APIs/ > + - The acknowledgment of the maintainer of the component is mandatory,= or if > + no maintainer is available for the component, the tree/sub-tree mai= ntainer > + for that component must be acknowledge the ABI change instead. s/must be/must/ Apart from that: Acked-by: John McNamara