ring: fix comment for __rte_ring_move_cons_head()
Checks
Commit Message
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")
Cc: bruce.richardson@intel.com
Cc: stable@dpdk.org
Signed-off-by: Cian Ferriter <cian.ferriter@intel.com>
---
lib/ring/rte_ring_c11_pvt.h | 2 +-
lib/ring/rte_ring_generic_pvt.h | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
Comments
<snip>
>
> 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")
> Cc: bruce.richardson@intel.com
> Cc: stable@dpdk.org
>
> Signed-off-by: Cian Ferriter <cian.ferriter@intel.com>
LGTM
Acked-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
> ---
> lib/ring/rte_ring_c11_pvt.h | 2 +-
> lib/ring/rte_ring_generic_pvt.h | 2 +-
> 2 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/lib/ring/rte_ring_c11_pvt.h b/lib/ring/rte_ring_c11_pvt.h index
> 37e0b2afd6..f895950df4 100644
> --- a/lib/ring/rte_ring_c11_pvt.h
> +++ b/lib/ring/rte_ring_c11_pvt.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/ring/rte_ring_generic_pvt.h b/lib/ring/rte_ring_generic_pvt.h
> index c95ad7e12c..5acb6e59be 100644
> --- a/lib/ring/rte_ring_generic_pvt.h
> +++ b/lib/ring/rte_ring_generic_pvt.h
> @@ -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
> > 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")
> > Cc: bruce.richardson@intel.com
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: Cian Ferriter <cian.ferriter@intel.com>
> LGTM
> Acked-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Applied, thanks.
@@ -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
@@ -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