From: Andrzej Ostruszka Date: Thu, 7 Nov 2019 15:03:07 +0000 (+0100) Subject: doc: fix description of versioning macros X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=519e6548f7a679d769182866a71df98f6b6a85d8;p=dpdk.git 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 Acked-by: Neil Horman --- diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst index 64984c54e6..8a38928c02 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 55e88ffae6..eae619d605 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 @DPDK_ to the internal - * function name _ + * function name */ #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 to the internal symbol _ + * symbol to the internal symbol */ #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))