diff mbox series

ring: fix comment for __rte_ring_move_cons_head()

Message ID 20210823172844.72394-1-cian.ferriter@intel.com (mailing list archive)
State Accepted
Delegated to: Thomas Monjalon
Headers show
Series ring: fix comment for __rte_ring_move_cons_head() | expand

Checks

Context Check Description
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-aarch64-unit-testing fail Testing issues
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing fail Testing issues
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/checkpatch success coding style OK

Commit Message

Cian Ferriter Aug. 23, 2021, 5:28 p.m. UTC
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

Honnappa Nagarahalli Aug. 24, 2021, 7:32 p.m. UTC | #1
<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
Thomas Monjalon Oct. 1, 2021, 12:47 p.m. UTC | #2
> > 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.
diff mbox series

Patch

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