diff mbox series

[v1] ring: correct the comment and figure description

Message ID 20220408124042.272882-1-haiyue.wang@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v1] ring: correct the comment and figure description |

Checks

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

Commit Message

Wang, Haiyue April 8, 2022, 12:40 p.m. UTC 
  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'.

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

Comments

Thomas Monjalon Nov. 15, 2022, 4:41 p.m. UTC | #1 
08/04/2022 14:40, Haiyue Wang:
> 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'.
> 
> Signed-off-by: Haiyue Wang <haiyue.wang@intel.com>

There was no comment, I assume it is OK.
Applied, thanks.
diff mbox series

Patch

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/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 {
  * 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.