doc: add abi policy changes to release notes

Message ID 1574082928-14863-1-git-send-email-mdr@ashroe.eu (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: add abi policy changes to release notes |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed

Commit Message

Ray Kinsella Nov. 18, 2019, 1:15 p.m. UTC
  Add some pointers to the releases notes on the changes to the abi policy,
the introduction of project-level ABI management and the deprecation of
library-level management.

Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
---
 doc/guides/rel_notes/release_19_11.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)
  

Comments

John McNamara Nov. 25, 2019, 10:55 a.m. UTC | #1
> -----Original Message-----
> From: Ray Kinsella <mdr@ashroe.eu>
> Sent: Monday, November 18, 2019 1:15 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; marko.kovacevic@intel.co;
> Ray Kinsella <mdr@ashroe.eu>
> Subject: [PATCH] doc: add abi policy changes to release notes
> 
> Add some pointers to the releases notes on the changes to the abi policy,
> the introduction of project-level ABI management and the deprecation of
> library-level management.
> 
> Signed-off-by: Ray Kinsella <mdr@ashroe.eu>


Acked-by: John McNamara <john.mcnamara@intel.com>
  
Thomas Monjalon Nov. 26, 2019, 10:50 p.m. UTC | #2
> > Add some pointers to the releases notes on the changes to the abi policy,
> > the introduction of project-level ABI management and the deprecation of
> > library-level management.
> > 
> > Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst
index c0045a9..9a2518c 100644
--- a/doc/guides/rel_notes/release_19_11.rst
+++ b/doc/guides/rel_notes/release_19_11.rst
@@ -308,6 +308,11 @@  Removed Items
    Also, make sure to start the actual text at the margin.
    =========================================================
 
+* Removed library-level ABI versions. These have been replaced with a single
+  project-level ABI version for non-experimental libraries and an ABI version of
+  ``0`` for experimental libraries. Review the :doc:`../contributing/abi_policy`
+  and :doc:`../contributing/abi_versioning` guides for more information.
+
 * Removed duplicated set of commands for Rx offload configuration from testpmd::
 
     port config all crc-strip|scatter|rx-cksum|rx-timestamp|
@@ -446,6 +451,12 @@  ABI Changes
    Also, make sure to start the actual text at the margin.
    =========================================================
 
+* policy: Please note the revisions to the :doc:`../contributing/abi_policy`
+  introducing major ABI versions, with DPDK 19.11 becoming the first major
+  version ``v20``. ABI changes to add new features continue to be permitted in
+  subsequent releases, with the condition that ABI compatibility with the major
+  ABI version is maintained.
+
 * net: The Ethernet address and other header definitions have changed
   attributes. They have been modified to be aligned on 2-byte boundaries.
   These changes should not impact normal usage because drivers naturally