This patch fixes documentation of versioning macros so that they are
aligned with their implementation (no underscore is added by macros).
Signed-off-by: Andrzej Ostruszka <aostrus...@marvell.com>
Fixes: f1ef9794f9bd ("doc: add ABI guidelines")
Acked-by: Neil Horman <nhor...@tuxdriver.com>
---
doc/guides/contributing/versioning.rst | 4 ++--
lib/librte_eal/common/include/rte_function_versioning.h | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/doc/guides/contributing/versioning.rst
b/doc/guides/contributing/versioning.rst
index 64984c54e..8a38928c0 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 55e88ffae..eae619d60 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))
--
2.17.1
