abi: document reasons behind the three part versioning
PATCH 1/1 abi: document reasons behind the three part versioning
Clarify the reasons behind the three part version numbering scheme. Documents the fixes made in f26c2b3.
--- doc/guides/contributing/abi_policy.rst | 3 ++- doc/guides/rel_notes/release_20_05.rst | 12 ++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-)
doc/guides/contributing/abi_policy.rst +2 -1
@@ -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_05_abi_changes>`. What is an ABI? ~~~~~~~~~~~~~~~
doc/guides/rel_notes/release_20_05.rst +12 -0
@@ -164,6 +164,7 @@ API Changes Also, make sure to start the actual text at the margin. ========================================================= +.. _20_05_abi_changes: ABI Changes -----------
@@ -180,6 +181,17 @@ ABI Changes Also, make sure to start the actual text at the margin. ========================================================= +* 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 f26c2b3 + <https://git.dpdk.org/dpdk/commit/?id=f26c2b39b271cdcd857ba518c5e48c78cb1c30af>`_ + 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. + * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
Signature · 1 line
2.7.4
23/04/2020 12:12, Ray Kinsella:
Quoted 2 lines
Clarify the reasons behind the three part version numbering scheme. Documents the fixes made in f26c2b3.
Please add these lines:
doc/guides/contributing/abi_policy.rst General Guidelines · line 43
Quoted 7 lines
Signed-off-by Ray Kinsella <[email protected]>Signed-off-by Bruce Richardson <[email protected]>---
doc/guides/contributing/abi_policy.rst +2
-0+ lengthening the stability period. Additional implementation detail can be + found in the :ref:`release notes <20_05_abi_changes>`.
The three part version was done in 20.02.
I think you should update the 20.02 release notes instead of 20.05.
Quoted 9 lines · Thomas Monjalon
23/04/2020 12:12, Ray Kinsella:
Quoted 2 lines
Clarify the reasons behind the three part version numbering scheme. Documents the fixes made in f26c2b3.
Please add these lines:
Fixes f26c2b39b271 ("build: fix soname info for 19.11 compatibility")
Quoted 11 lines
doc/guides/contributing/abi_policy.rst General Guidelines · line 43
Quoted 7 lines
Signed-off-by Ray Kinsella <[email protected]>Signed-off-by Bruce Richardson <[email protected]>---
doc/guides/contributing/abi_policy.rst +2
-0+ lengthening the stability period. Additional implementation detail can be + found in the :ref:`release notes <20_05_abi_changes>`.The three part version was done in 20.02.
I think you should update the 20.02 release notes instead of 20.05.
I agreed,
However I didn't think that was possible on a quarterly, after the release was formally complete. Wouldn't that involve either a respin or a .1 ?
Ray K
05/05/2020 10:07, Ray Kinsella:
Quoted 22 lines · Thomas Monjalon
Quoted 9 lines
23/04/2020 12:12, Ray Kinsella:
Quoted 2 lines
Clarify the reasons behind the three part version numbering scheme. Documents the fixes made in f26c2b3.
Please add these lines:
Fixes f26c2b39b271 ("build: fix soname info for 19.11 compatibility")Quoted 11 lines
doc/guides/contributing/abi_policy.rst General Guidelines · line 43
Quoted 7 lines
Signed-off-by Ray Kinsella <[email protected]>Signed-off-by Bruce Richardson <[email protected]>---
doc/guides/contributing/abi_policy.rst +2
-0+ lengthening the stability period. Additional implementation detail can be + found in the :ref:`release notes <20_05_abi_changes>`.The three part version was done in 20.02.
I think you should update the 20.02 release notes instead of 20.05.
Quoted 3 lines
I agreed,
However I didn't think that was possible on a quarterly, after the release was formally complete. Wouldn't that involve either a respin or a .1 ?
Yes please respin a v2
PATCH v2 1/1 abi: document reasons behind the three part versioning
In reply to Ray KinsellaClarify the reasons behind the three part version numbering scheme. Documents the fixes made in f26c2b3.
---
v2:
* Added "fixes" to commit message.
doc/guides/contributing/abi_policy.rst | 3 ++- doc/guides/rel_notes/release_20_05.rst | 12 ++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-)
doc/guides/contributing/abi_policy.rst +2 -1
@@ -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_05_abi_changes>`. What is an ABI? ~~~~~~~~~~~~~~~
doc/guides/rel_notes/release_20_05.rst +12 -0
@@ -245,6 +245,7 @@ API Changes ``rte_mempool_populate_virt()`` changed to return 0 instead of -EINVAL when there is not enough room to store one object. +.. _20_05_abi_changes: ABI Changes -----------
@@ -261,6 +262,17 @@ ABI Changes Also, make sure to start the actual text at the margin. ========================================================= +* 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 f26c2b3 + <https://git.dpdk.org/dpdk/commit/?id=f26c2b39b271cdcd857ba518c5e48c78cb1c30af>`_ + 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. + * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
--
2.7.4
05/05/2020 10:56, Ray Kinsella:
Quoted 5 lines
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")
Quoted 8 lines
Signed-off-by Ray Kinsella <[email protected]>Signed-off-by Bruce Richardson <[email protected]>---
v2:
* Added "fixes" to commit message.doc/guides/contributing/abi_policy.rst | 3 ++- doc/guides/rel_notes/release_20_05.rst | 12 ++++++++++++
Moved to release_20_02.rst and applied, thanks.
Note: the updated release notes will be published as part of 20.05.