Skip to content

Commit

Permalink
doc: fix description of versioning macros
Browse files Browse the repository at this point in the history
[ upstream commit 519e654 ]

This patch fixes documentation of versioning macros so that they are
aligned with their implementation (no underscore is added by macros).

Fixes: f1ef979 ("doc: add ABI guidelines")

Signed-off-by: Andrzej Ostruszka <aostruszka@marvell.com>
Acked-by: Neil Horman <nhorman@tuxdriver.com>
  • Loading branch information
Andrzej Ostruszka authored and kevintraynor committed Dec 10, 2019
1 parent 7a93e04 commit 65ccd7c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions doc/guides/contributing/versioning.rst
Expand Up @@ -176,11 +176,11 @@ library so that older binaries need not be immediately recompiled.
The macros exported are:

* ``VERSION_SYMBOL(b, e, n)``: Creates a symbol version table entry binding
versioned symbol ``b@DPDK_n`` to the internal function ``b_e``.
versioned symbol ``b@DPDK_n`` to the internal function ``be``.

* ``BIND_DEFAULT_SYMBOL(b, e, n)``: Creates a symbol version entry instructing
the linker to bind references to symbol ``b`` to the internal symbol
``b_e``.
``be``.

* ``MAP_STATIC_SYMBOL(f, p)``: Declare the prototype ``f``, and map it to the
fully qualified function ``p``, so that if a symbol becomes versioned, it
Expand Down
4 changes: 2 additions & 2 deletions lib/librte_compat/rte_compat.h
Expand Up @@ -38,14 +38,14 @@
/*
* VERSION_SYMBOL
* Creates a symbol version table entry binding symbol <b>@DPDK_<n> to the internal
* function name <b>_<e>
* function name <b><e>
*/
#define VERSION_SYMBOL(b, e, n) __asm__(".symver " RTE_STR(b) RTE_STR(e) ", " RTE_STR(b) "@DPDK_" RTE_STR(n))

/*
* BIND_DEFAULT_SYMBOL
* Creates a symbol version entry instructing the linker to bind references to
* symbol <b> to the internal symbol <b>_<e>
* symbol <b> to the internal symbol <b><e>
*/
#define BIND_DEFAULT_SYMBOL(b, e, n) __asm__(".symver " RTE_STR(b) RTE_STR(e) ", " RTE_STR(b) "@@DPDK_" RTE_STR(n))
#define __vsym __attribute__((used))
Expand Down

0 comments on commit 65ccd7c

Please sign in to comment.