summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrzej Ostruszka <aostruszka@marvell.com>2019-11-07 16:03:07 +0100
committerThomas Monjalon <thomas@monjalon.net>2019-11-08 15:15:09 +0100
commit519e6548f7a679d769182866a71df98f6b6a85d8 (patch)
tree2f9db24d5c731101f4f1af74206e020e4453bd12
parent9a643edb2b74c5993465089aa23178cd9ad612cc (diff)
downloaddpdk-519e6548f7a679d769182866a71df98f6b6a85d8.zip
dpdk-519e6548f7a679d769182866a71df98f6b6a85d8.tar.gz
dpdk-519e6548f7a679d769182866a71df98f6b6a85d8.tar.xz
doc: fix description of versioning macros
This patch fixes documentation of versioning macros so that they are aligned with their implementation (no underscore is added by macros). Fixes: f1ef9794f9bd ("doc: add ABI guidelines") Cc: stable@dpdk.org Signed-off-by: Andrzej Ostruszka <aostruszka@marvell.com> Acked-by: Neil Horman <nhorman@tuxdriver.com>
-rw-r--r--doc/guides/contributing/versioning.rst4
-rw-r--r--lib/librte_eal/common/include/rte_function_versioning.h4
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst
index 64984c5..8a38928 100644
--- a/doc/guides/contributing/versioning.rst
+++ b/doc/guides/contributing/versioning.rst
@@ -215,11 +215,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
diff --git a/lib/librte_eal/common/include/rte_function_versioning.h b/lib/librte_eal/common/include/rte_function_versioning.h
index 55e88ff..eae619d 100644
--- a/lib/librte_eal/common/include/rte_function_versioning.h
+++ b/lib/librte_eal/common/include/rte_function_versioning.h
@@ -42,14 +42,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))