diff mbox series

ring: fix namesize macro documentation block

Message ID 20190404123454.16755-1-gage.eads@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series ring: fix namesize macro documentation block |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Eads, Gage April 4, 2019, 12:34 p.m. UTC 
  '/**<' style comments apply to the previous member, which caused doxygen to
emit the RTE_RING_NAMESIZE documentation for RTE_RING_MZ_PREFIX.

Fixes: 38c9817ee1d8 ("mempool: adjust name size in related data types")
Cc: stable@dpdk.org

Signed-off-by: Gage Eads <gage.eads@intel.com>
---
 lib/librte_ring/rte_ring.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Thomas Monjalon April 4, 2019, 3:45 p.m. UTC | #1 
04/04/2019 14:34, Gage Eads:
> '/**<' style comments apply to the previous member, which caused doxygen to
> emit the RTE_RING_NAMESIZE documentation for RTE_RING_MZ_PREFIX.
> 
> Fixes: 38c9817ee1d8 ("mempool: adjust name size in related data types")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Gage Eads <gage.eads@intel.com>

Applied, thanks
diff mbox series

Patch

diff --git a/lib/librte_ring/rte_ring.h b/lib/librte_ring/rte_ring.h
index af5444a9f..83d0f6f83 100644
--- a/lib/librte_ring/rte_ring.h
+++ b/lib/librte_ring/rte_ring.h
@@ -57,7 +57,7 @@  enum rte_ring_queue_behavior {
 };
 
 #define RTE_RING_MZ_PREFIX "RG_"
-/**< The maximum length of a ring name. */
+/** The maximum length of a ring name. */
 #define RTE_RING_NAMESIZE (RTE_MEMZONE_NAMESIZE - \
 			   sizeof(RTE_RING_MZ_PREFIX) + 1)