From 701d4730ef56b667c6b89118378b9dfe09a5f8ac Mon Sep 17 00:00:00 2001 From: Cian Ferriter Date: Mon, 23 Aug 2021 18:28:44 +0100 Subject: [PATCH] ring: fix Doxygen comment of internal function [ upstream commit 0203a14c72da4ae726056a147cb6e51622c9c28e ] Change "enqueue" to "dequeue" because the __rte_ring_move_cons_head() function is updating the consumer head for dequeue. Fixes: 0dfc98c507b1 ("ring: separate out head index manipulation") Signed-off-by: Cian Ferriter Acked-by: Honnappa Nagarahalli --- lib/librte_ring/rte_ring_c11_mem.h | 2 +- lib/librte_ring/rte_ring_generic.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/librte_ring/rte_ring_c11_mem.h b/lib/librte_ring/rte_ring_c11_mem.h index 0fb73a3371..ae886532ee 100644 --- a/lib/librte_ring/rte_ring_c11_mem.h +++ b/lib/librte_ring/rte_ring_c11_mem.h @@ -111,7 +111,7 @@ __rte_ring_move_prod_head(struct rte_ring *r, unsigned int is_sp, * @param is_sc * Indicates whether multi-consumer path is needed or not * @param n - * The number of elements we will want to enqueue, i.e. how far should the + * The number of elements we will want to dequeue, i.e. how far should the * head be moved * @param behavior * RTE_RING_QUEUE_FIXED: Dequeue a fixed number of items from a ring diff --git a/lib/librte_ring/rte_ring_generic.h b/lib/librte_ring/rte_ring_generic.h index 953cdbbd5e..79ae4ecb14 100644 --- a/lib/librte_ring/rte_ring_generic.h +++ b/lib/librte_ring/rte_ring_generic.h @@ -107,7 +107,7 @@ __rte_ring_move_prod_head(struct rte_ring *r, unsigned int is_sp, * @param is_sc * Indicates whether multi-consumer path is needed or not * @param n - * The number of elements we will want to enqueue, i.e. how far should the + * The number of elements we will want to dequeue, i.e. how far should the * head be moved * @param behavior * RTE_RING_QUEUE_FIXED: Dequeue a fixed number of items from a ring