[v1] ring: correct the comment and figure description
Checks
Commit Message
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
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.
@@ -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
@@ -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.