Skip to contentSkip to conversation

build: fix version map file references in documentation

PATCH Applied David Marchand 3 participants 5 messages Oct 22, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 build: fix version map file references in documentation

Fixes 63b3907833d8 ("build: remove library name from version map file name")

---
Note: we might want to update the ABI version in the examples shown in the documentation. I can send a followup patch.

---
 doc/guides/contributing/abi_versioning.rst       | 14 +++++++-------
 lib/librte_eal/include/rte_function_versioning.h |  2 +-
 2 files changed, 8 insertions(+), 8 deletions(-)
doc/guides/contributing/abi_versioning.rst +7 -7
index 7a771dba10..b8b35761e2 100644
@@ -58,12 +58,12 @@ persists over multiple releases.
 
 .. code-block:: none
 
- $ head ./lib/librte_acl/rte_acl_version.map
+ $ head ./lib/librte_acl/version.map
  DPDK_20 {
         global:
  ...
 
- $ head ./lib/librte_eal/rte_eal_version.map
+ $ head ./lib/librte_eal/version.map
  DPDK_20 {
         global:
  ...
@@ -77,7 +77,7 @@ that library.
 
 .. code-block:: none
 
- $ head ./lib/librte_acl/rte_acl_version.map
+ $ head ./lib/librte_acl/version.map
  DPDK_20 {
         global:
  ...
@@ -88,7 +88,7 @@ that library.
  } DPDK_20;
  ...
 
- $ head ./lib/librte_eal/rte_eal_version.map
+ $ head ./lib/librte_eal/version.map
  DPDK_20 {
         global:
  ...
@@ -100,12 +100,12 @@ how this may be done.
 
 .. code-block:: none
 
- $ head ./lib/librte_acl/rte_acl_version.map
+ $ head ./lib/librte_acl/version.map
  DPDK_21 {
         global:
  ...
 
- $ head ./lib/librte_eal/rte_eal_version.map
+ $ head ./lib/librte_eal/version.map
  DPDK_21 {
         global:
  ...
@@ -134,7 +134,7 @@ linked to the DPDK.
 
 To support backward compatibility the ``rte_function_versioning.h``
 header file provides macros to use when updating exported functions. These
-macros are used in conjunction with the ``rte_<library>_version.map`` file for
+macros are used in conjunction with the ``version.map`` file for
 a given library to allow multiple versions of a symbol to exist in a shared
 library so that older binaries need not be immediately recompiled.
 
lib/librte_eal/include/rte_function_versioning.h +1 -1
index f588f2643b..746a1e1992 100644
@@ -22,7 +22,7 @@
  * allow for backwards compatibility for a time with older binaries that are
  * dynamically linked to the dpdk.  To support that, the __vsym and
  * VERSION_SYMBOL macros are created.  They, in conjunction with the
- * <library>_version.map file for a given library allow for multiple versions of
+ * version.map file for a given library allow for multiple versions of
  * a symbol to exist in a shared library so that older binaries need not be
  * immediately recompiled.
  *
Signature · 1 line
2.23.0
Acked-by on v1 1/1
#1 lore raw
Quoted 6 lines · David Marchand
Fixes 63b3907833d8 ("build: remove library name from version map file name")

---
Note: we might want to update the ABI version in the examples shown in the documentation. I can send a followup patch.

I was thinking similar, I can do it also.

Quoted 72 lines
---
 doc/guides/contributing/abi_versioning.rst       | 14 +++++++-------
 lib/librte_eal/include/rte_function_versioning.h |  2 +-
 2 files changed, 8 insertions(+), 8 deletions(-)
doc/guides/contributing/abi_versioning.rst +7 -7
index 7a771dba10..b8b35761e2 100644
@@ -58,12 +58,12 @@ persists over multiple releases.
 
 .. code-block:: none
 
- $ head ./lib/librte_acl/rte_acl_version.map
+ $ head ./lib/librte_acl/version.map
  DPDK_20 {
         global:
...
 
- $ head ./lib/librte_eal/rte_eal_version.map
+ $ head ./lib/librte_eal/version.map
  DPDK_20 {
         global:
...
@@ -77,7 +77,7 @@ that library.
 
 .. code-block:: none
 
- $ head ./lib/librte_acl/rte_acl_version.map
+ $ head ./lib/librte_acl/version.map
  DPDK_20 {
         global:
...
@@ -88,7 +88,7 @@ that library.
  } DPDK_20;
...
 
- $ head ./lib/librte_eal/rte_eal_version.map
+ $ head ./lib/librte_eal/version.map
  DPDK_20 {
         global:
...
@@ -100,12 +100,12 @@ how this may be done.
 
 .. code-block:: none
 
- $ head ./lib/librte_acl/rte_acl_version.map
+ $ head ./lib/librte_acl/version.map
  DPDK_21 {
         global:
...
 
- $ head ./lib/librte_eal/rte_eal_version.map
+ $ head ./lib/librte_eal/version.map
  DPDK_21 {
         global:
...
@@ -134,7 +134,7 @@ linked to the DPDK.
 
 To support backward compatibility the ``rte_function_versioning.h``
 header file provides macros to use when updating exported functions. These
-macros are used in conjunction with the ``rte_<library>_version.map`` file for
+macros are used in conjunction with the ``version.map`` file for
 a given library to allow multiple versions of a symbol to exist in a shared
 library so that older binaries need not be immediately recompiled.
 
lib/librte_eal/include/rte_function_versioning.h +0 -0
index f588f2643b..746a1e1992 100644

lib/librte_eal/include/rte_function_versioning.h line 28

Quoted 8 lines
lib/librte_eal/include/rte_function_versioning.h +1 -1
@@ -22,7 +22,7 @@
  * allow for backwards compatibility for a time with older binaries that are
  * dynamically linked to the dpdk.  To support that, the __vsym and
  * VERSION_SYMBOL macros are created.  They, in conjunction with the
- * <library>_version.map file for a given library allow for multiple versions of
+ * version.map file for a given library allow for multiple versions of
  * a symbol to exist in a shared library so that older binaries need not be
  * immediately recompiled.
  *
author Acked-by Ray Kinsella Acked-by Bruce Richardson on v1 1/1 Applied
#3 lore raw
In reply to David Marchand
Quoted 4 lines · David Marchand
Fixes 63b3907833d8 ("build: remove library name from version map file name")

Applied, thanks.

Ray, I'll let you update the documentation with better examples on the ABI version.
Thanks.

Signature · 1 line
David Marchand