Skip to contentSkip to conversation

ring: fix comment for __rte_ring_move_cons_head()

PATCH Applied Cian Ferriter 3 participants 3 messages Aug 23, 2021 – Oct 1, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 ring: fix comment for __rte_ring_move_cons_head()

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")
---
 lib/ring/rte_ring_c11_pvt.h     | 2 +-
 lib/ring/rte_ring_generic_pvt.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
lib/ring/rte_ring_c11_pvt.h +1 -1
index 37e0b2afd6..f895950df4 100644
@@ -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
lib/ring/rte_ring_generic_pvt.h +1 -1
index c95ad7e12c..5acb6e59be 100644
@@ -106,7 +106,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
Signature · 1 line
2.32.0
Acked-by on v1 1/1
#1 lore raw

<snip>

Quoted 9 lines

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")

LGTM

Quoted 35 lines
---
 lib/ring/rte_ring_c11_pvt.h     | 2 +-
 lib/ring/rte_ring_generic_pvt.h | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
lib/ring/rte_ring_c11_pvt.h index renamed from lib/ring/rte_ring_c11_pvt.h +0 -0

37e0b2afd6..f895950df4 100644

lib/ring/rte_ring_c11_pvt.h +1 -1
@@ -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

lib/ring/rte_ring_generic_pvt.h +1 -1
index c95ad7e12c..5acb6e59be 100644
@@ -106,7 +106,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
--
2.32.0