[dpdk-dev] [PATCH] build: fix version map file references in documentation

[dpdk-dev] [PATCH] build: fix version map file references in documentation

[David Marchand]

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

Signed-off-by: David Marchand <david.marchand@redhat.com>
---
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(-)

diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst
index 7a771dba10..b8b35761e2 100644
--- a/doc/guides/contributing/abi_versioning.rst
+++ b/doc/guides/contributing/abi_versioning.rst
@@ -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.
 
diff --git a/lib/librte_eal/include/rte_function_versioning.h b/lib/librte_eal/include/rte_function_versioning.h
index f588f2643b..746a1e1992 100644
--- a/lib/librte_eal/include/rte_function_versioning.h
+++ b/lib/librte_eal/include/rte_function_versioning.h
@@ -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.
  *
-- 
2.23.0

Re: [dpdk-dev] [PATCH] build: fix version map file references in documentation

[Kinsella, Ray]

On 22/10/2020 08:47, David Marchand wrote:
> Fixes: 63b3907833d8 ("build: remove library name from version map file name")
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---
> 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.

> ---
>  doc/guides/contributing/abi_versioning.rst       | 14 +++++++-------
>  lib/librte_eal/include/rte_function_versioning.h |  2 +-
>  2 files changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst
> index 7a771dba10..b8b35761e2 100644
> --- a/doc/guides/contributing/abi_versioning.rst
> +++ b/doc/guides/contributing/abi_versioning.rst
> @@ -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.
>  
> diff --git a/lib/librte_eal/include/rte_function_versioning.h b/lib/librte_eal/include/rte_function_versioning.h
> index f588f2643b..746a1e1992 100644
> --- a/lib/librte_eal/include/rte_function_versioning.h
> +++ b/lib/librte_eal/include/rte_function_versioning.h
> @@ -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.
>   *
> 

Acked-by: Ray Kinsella <mdr@ashroe.eu>

Re: [dpdk-dev] [PATCH] build: fix version map file references in documentation

[Bruce Richardson]

On Thu, Oct 22, 2020 at 09:47:04AM +0200, David Marchand wrote:
> Fixes: 63b3907833d8 ("build: remove library name from version map file name")
> 
> Signed-off-by: David Marchand <david.marchand@redhat.com>
> ---

Thanks. I never thought that there might be references to the version maps
including their filenames in the docs.

Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Re: [dpdk-dev] [PATCH] build: fix version map file references in documentation

[David Marchand]

On Thu, Oct 22, 2020 at 9:47 AM David Marchand
<david.marchand@redhat.com> wrote:
>
> Fixes: 63b3907833d8 ("build: remove library name from version map file name")
>
> Signed-off-by: David Marchand <david.marchand@redhat.com>
Acked-by: Ray Kinsella <mdr@ashroe.eu>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks.

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

-- 
David Marchand

Re: [dpdk-dev] [PATCH] build: fix version map file references in documentation

[Kinsella, Ray]

No worries, happy to.

On 22/10/2020 13:11, David Marchand wrote:
> On Thu, Oct 22, 2020 at 9:47 AM David Marchand
> <david.marchand@redhat.com> wrote:
>>
>> Fixes: 63b3907833d8 ("build: remove library name from version map file name")
>>
>> Signed-off-by: David Marchand <david.marchand@redhat.com>
> Acked-by: Ray Kinsella <mdr@ashroe.eu>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> 
> Applied, thanks.
> 
> Ray, I'll let you update the documentation with better examples on the
> ABI version.
> Thanks.
>