[PATCH] doc: announce new major ABI version

[PATCH] doc: announce new major ABI version

[Thomas Monjalon]

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>
---
 doc/guides/rel_notes/deprecation.rst | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 91ac8f0229..55e4b2253e 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -4,9 +4,14 @@
 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>`.
+
+With DPDK 23.11, there will be a new major ABI version: 24.
+It means that during the development of 23.11, it will be allowed
+to add new items in a struct or enum involving ABI compatibility breakage.
+
+Other API and ABI deprecation notices are to be posted here.
 
 Deprecation Notices
 -------------------
-- 
2.41.0

[PATCH v2] doc: announce new major ABI version

[Thomas Monjalon]

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>`.
+
+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.
 
 Deprecation Notices
 -------------------
-- 
2.41.0

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

[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.

> +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>

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

[Thomas Monjalon]

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

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

[Patrick Robb]

[-- Attachment #1: Type: text/plain, Size: 100 bytes --]

The Community Lab's ABI testing on new patchseries is now disabled until
the 23.11 release. Thanks.

[-- Attachment #2: Type: text/html, Size: 128 bytes --]

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

[Thomas Monjalon]

28/07/2023 19:02, Patrick Robb:
> The Community Lab's ABI testing on new patchseries is now disabled until
> the 23.11 release. Thanks.

Perfect, thank you.

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

[Akhil Goyal]

[-- Attachment #1: Type: text/plain, Size: 559 bytes --]

I believe it is not disabled in some checks.
http://mails.dpdk.org/archives/test-report/2023-July/432810.html
This is reported for today’s patch.

From: Patrick Robb <probb@iol.unh.edu>
Sent: Friday, July 28, 2023 10:32 PM
To: Thomas Monjalon <thomas@monjalon.net>
Cc: Bruce Richardson <bruce.richardson@intel.com>; dev@dpdk.org
Subject: [EXT] Re: [PATCH v2] doc: announce new major ABI version

External Email
________________________________
The Community Lab's ABI testing on new patchseries is now disabled until the 23.11 release. Thanks.

[-- Attachment #2: Type: text/html, Size: 3048 bytes --]

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

[Morten Brørup]

> From: Thomas Monjalon [mailto:thomas@monjalon.net]
> Sent: Friday, 28 July 2023 17.19
> 
> 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>
> ---

Acked-by: Morten Brørup <mb@smartsharesystems.com>