patch 'ring: fix description' has been queued to stable release 20.11.7

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 20.11.7

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/19/22. 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/kevintraynor/dpdk-stable

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable/commit/229138af8427090e3693c3a2332667149315b8d9

Thanks.

Luca Boccassi

---
>From 229138af8427090e3693c3a2332667149315b8d9 Mon Sep 17 00:00:00 2001
From: Haiyue Wang <haiyue.wang at intel.com>
Date: Fri, 8 Apr 2022 20:40:42 +0800
Subject: [PATCH] ring: fix description

[ upstream commit a2248c87e2ba9aa0b455e8b4b90ec713aa212749 ]

The index description isn't right,
correct it as the Programmer's guide said.

Also correct the guide's figure description about 'Dequeue First Step'.

Fixes: 4a22e6ee3d2f ("doc: refactor figure numbers into references")
Fixes: af75078fece3 ("first public release")

Signed-off-by: Haiyue Wang <haiyue.wang at intel.com>
---
 doc/guides/prog_guide/ring_lib.rst | 2 +-
 lib/librte_ring/rte_ring_core.h    | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/guides/prog_guide/ring_lib.rst b/doc/guides/prog_guide/ring_lib.rst
index 54e0bb4b68..515a715266 100644
--- a/doc/guides/prog_guide/ring_lib.rst
+++ b/doc/guides/prog_guide/ring_lib.rst
@@ -172,7 +172,7 @@ If there are not enough objects in the ring (this is detected by checking prod_t
 
 .. figure:: img/ring-dequeue1.*
 
-   Dequeue last step
+   Dequeue first step
 
 
 Dequeue Second Step
diff --git a/lib/librte_ring/rte_ring_core.h b/lib/librte_ring/rte_ring_core.h
index 25d2244a69..0503d5798e 100644
--- a/lib/librte_ring/rte_ring_core.h
+++ b/lib/librte_ring/rte_ring_core.h
@@ -114,8 +114,8 @@ struct rte_ring_hts_headtail {
  * An RTE ring structure.
  *
  * The producer and the consumer have a head and a tail index. The particularity
- * of these index is that they are not between 0 and size(ring). These indexes
- * are between 0 and 2^32, and we mask their value when we access the ring[]
+ * of these index is that they are not between 0 and size(ring)-1. These indexes
+ * are between 0 and 2^32 -1, and we mask their value when we access the ring[]
  * field. Thanks to this assumption, we can do subtractions between 2 index
  * values in a modulo-32bit base: that's why the overflow of the indexes is not
  * a problem.
-- 
2.34.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2022-11-17 23:07:56.870092112 +0000
+++ 0033-ring-fix-description.patch	2022-11-17 23:07:55.560331899 +0000
@@ -1 +1 @@
-From a2248c87e2ba9aa0b455e8b4b90ec713aa212749 Mon Sep 17 00:00:00 2001
+From 229138af8427090e3693c3a2332667149315b8d9 Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit a2248c87e2ba9aa0b455e8b4b90ec713aa212749 ]
+
@@ -13 +14,0 @@
-Cc: stable at dpdk.org
@@ -18 +19 @@
- lib/ring/rte_ring_core.h           | 4 ++--
+ lib/librte_ring/rte_ring_core.h    | 4 ++--
@@ -34,5 +35,5 @@
-diff --git a/lib/ring/rte_ring_core.h b/lib/ring/rte_ring_core.h
-index 1252ca9546..82b237091b 100644
---- a/lib/ring/rte_ring_core.h
-+++ b/lib/ring/rte_ring_core.h
-@@ -111,8 +111,8 @@ struct rte_ring_hts_headtail {
+diff --git a/lib/librte_ring/rte_ring_core.h b/lib/librte_ring/rte_ring_core.h
+index 25d2244a69..0503d5798e 100644
+--- a/lib/librte_ring/rte_ring_core.h
++++ b/lib/librte_ring/rte_ring_core.h
+@@ -114,8 +114,8 @@ struct rte_ring_hts_headtail {