From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: Re: [PATCH] doc: update ABI/API policy Date: Sat, 11 Nov 2017 12:37:32 +0100 Message-ID: <3221240.QpuMyaO2Qa@xps> References: <20171106112806.104289-1-bruce.richardson@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7Bit Cc: dev@dpdk.org, "Mcnamara, John" To: "Richardson, Bruce" Return-path: Received: from out4-smtp.messagingengine.com (out4-smtp.messagingengine.com [66.111.4.28]) by dpdk.org (Postfix) with ESMTP id 33FB61B392 for ; Sat, 11 Nov 2017 14:54:06 +0100 (CET) In-Reply-To: List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 06/11/2017 15:48, Mcnamara, John: > From: Richardson, Bruce > > > > Following agreement at the DPDK Technical Board meeting of 2017-10-13 [1], > > update the documentation with the ABI/API policy changes. > > > > [1] http://dpdk.org/ml/archives/dev/2017-October/079961.html > > > > Signed-off-by: Bruce Richardson > > --- > > doc/guides/contributing/versioning.rst | 19 ++++++++++++++++++- > > 1 file changed, 18 insertions(+), 1 deletion(-) > > > > 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 > > ------------------ > > > > #. Whenever possible, ABI should be preserved -#. The libraries marked in > > 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 to > > 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 maintainer > > + for that component must be acknowledge the ABI change instead. > > s/must be/must/ > > Apart from that: > > Acked-by: John McNamara Acked-by: Thomas Monjalon Applied with suggested changes, thanks