build: fix version map file references in documentation
PATCH 1/1 build: fix version map file references in documentation
---
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
@@ -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
@@ -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
Quoted 6 lines · David Marchand
Fixes 63b3907833d8 ("build: remove library name from version map file name")Signed-off-by David Marchand <[email protected]>---
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@@ -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
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. *
Quoted 4 lines · David Marchand
Fixes 63b3907833d8 ("build: remove library name from version map file name")Signed-off-by David Marchand <[email protected]>---
Thanks. I never thought that there might be references to the version maps including their filenames in the docs.
Quoted 4 lines · David Marchand
Fixes 63b3907833d8 ("build: remove library name from version map file name")Signed-off-by David Marchand <[email protected]>
Applied, thanks.
Ray, I'll let you update the documentation with better examples on the ABI version.
Thanks.
Signature · 1 line
David Marchand
No worries, happy to.
Quoted 15 lines · David Marchand
Quoted 4 lines · David Marchand
Fixes 63b3907833d8 ("build: remove library name from version map file name")Signed-off-by David Marchand <[email protected]>Acked-by Ray Kinsella <[email protected]>Acked-by Bruce Richardson <[email protected]>Applied, thanks.
Ray, I'll let you update the documentation with better examples on the ABI version.
Thanks.