[dpdk-stable] patch 'ring: fix Doxygen comment of internal function' has been queued to stable release 20.11.4

[Xueming Li]

Hi,

FYI, your patch has been queued to stable release 20.11.4

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 11/12/21. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/steevenlee/dpdk

This queued commit can be viewed at:
https://github.com/steevenlee/dpdk/commit/1e697abcfd978d22c3b56c9b9a00ffb294718dbe

Thanks.

Xueming Li <xuemingl at nvidia.com>

---
>From 1e697abcfd978d22c3b56c9b9a00ffb294718dbe Mon Sep 17 00:00:00 2001
From: Cian Ferriter <cian.ferriter at intel.com>
Date: Mon, 23 Aug 2021 18:28:44 +0100
Subject: [PATCH] ring: fix Doxygen comment of internal function
Cc: Xueming Li <xuemingl at nvidia.com>

[ 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 <cian.ferriter at intel.com>
Acked-by: Honnappa Nagarahalli <honnappa.nagarahalli at arm.com>
---
 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
-- 
2.33.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2021-11-10 14:17:05.697840966 +0800
+++ 0082-ring-fix-Doxygen-comment-of-internal-function.patch	2021-11-10 14:17:01.844079642 +0800
@@ -1 +1 @@
-From 0203a14c72da4ae726056a147cb6e51622c9c28e Mon Sep 17 00:00:00 2001
+From 1e697abcfd978d22c3b56c9b9a00ffb294718dbe Mon Sep 17 00:00:00 2001
@@ -4,0 +5,3 @@
+Cc: Xueming Li <xuemingl at nvidia.com>
+
+[ upstream commit 0203a14c72da4ae726056a147cb6e51622c9c28e ]
@@ -10 +12,0 @@
-Cc: stable at dpdk.org
@@ -15,2 +17,2 @@
- lib/ring/rte_ring_c11_pvt.h     | 2 +-
- lib/ring/rte_ring_generic_pvt.h | 2 +-
+ lib/librte_ring/rte_ring_c11_mem.h | 2 +-
+ lib/librte_ring/rte_ring_generic.h | 2 +-
@@ -19,4 +21,4 @@
-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
+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
@@ -32,5 +34,5 @@
-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,
+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,