From: Ray Kinsella Date: Tue, 5 May 2020 08:56:48 +0000 (+0100) Subject: doc: add reason for three-part ABI versioning X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=a57a71f9ffa81cf70219e36c0fc488d290038e61;p=dpdk.git doc: add reason for three-part ABI versioning Clarify the reasons behind the three part version numbering scheme. Documents the fixes made in f26c2b3. Fixes: f26c2b39b271 ("build: fix soname info for 19.11 compatibility") Cc: stable@dpdk.org Signed-off-by: Ray Kinsella Signed-off-by: Bruce Richardson --- diff --git a/doc/guides/contributing/abi_policy.rst b/doc/guides/contributing/abi_policy.rst index 05ca95980b..a488b53cf9 100644 --- a/doc/guides/contributing/abi_policy.rst +++ b/doc/guides/contributing/abi_policy.rst @@ -39,7 +39,8 @@ General Guidelines releases, over a number of release cycles. This change begins with maintaining ABI stability through one year of DPDK releases starting from DPDK 19.11. This policy will be reviewed in 2020, with intention of - lengthening the stability period. + lengthening the stability period. Additional implementation detail can be + found in the :ref:`release notes <20_02_abi_changes>`. What is an ABI? ~~~~~~~~~~~~~~~ diff --git a/doc/guides/rel_notes/release_20_02.rst b/doc/guides/rel_notes/release_20_02.rst index 870902f0b8..40ebbfac90 100644 --- a/doc/guides/rel_notes/release_20_02.rst +++ b/doc/guides/rel_notes/release_20_02.rst @@ -298,6 +298,8 @@ API Changes * No change in this release. +.. _20_02_abi_changes: + ABI Changes ----------- @@ -315,6 +317,16 @@ ABI Changes * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11. +* The soname for each stable ABI version should be just the ABI version major + number without the minor number. Unfortunately both major and minor were used + in the v19.11 release, causing version v20.x releases to be incompatible with + ABI v20.0. + + The `commit f26c2b39b271 `_ + fixed the issue by switching from 2-part to 3-part ABI version numbers so that + we can keep v20.0 as soname and using the final digits to identify the DPDK + 20.x releases which are ABI compatible. + Tested Platforms ----------------