> -----Original Message----- > From: Richardson, Bruce > Sent: Monday, November 6, 2017 11:28 AM > To: Mcnamara, John <john.mcnam...@intel.com> > Cc: dev@dpdk.org; Richardson, Bruce <bruce.richard...@intel.com> > Subject: [PATCH] doc: update ABI/API policy > > 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 <bruce.richard...@intel.com> > --- > 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 <john.mcnam...@intel.com>
