Re: [PATCH v2] doc: announce new major ABI version

[Thomas Monjalon <thomas@monjalon.net>]

28/07/2023 17:23, Bruce Richardson:
> On Fri, Jul 28, 2023 at 05:18:40PM +0200, Thomas Monjalon wrote:
> > The next DPDK release 23.11 won't keep ABI compatibility.
> > Only the changes impacting the users should be announced in advance.
> > 
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> > ---
> > v2: improve wording (thanks Bruce)
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 12 +++++++++---
> >  1 file changed, 9 insertions(+), 3 deletions(-)
> > 
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index 91ac8f0229..18281d7304 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -4,9 +4,15 @@
> >  ABI and API Deprecation
> >  =======================
> >  
> > -See the guidelines document for details of the :doc:`ABI policy
> > -<../contributing/abi_policy>`. API and ABI deprecation notices are to be posted
> > -here.
> > +See the guidelines document for details
> > +of the :doc:`ABI policy <../contributing/abi_policy>`.
> > +
> This has a strange line-break position. It can probably be a single line.

Will keep the original break which was better looking.

> > +With DPDK 23.11, there will be a new major ABI version: 24.
> > +This means that during the development of 23.11,
> > +new items may be added to structs or enums,
> > +even if those additions involve an ABI compatibility breakage.
> > +
> > +Other API and ABI deprecation notices are to be posted below.
> 
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied