From a2248c87e2ba9aa0b455e8b4b90ec713aa212749 Mon Sep 17 00:00:00 2001 From: Haiyue Wang Date: Fri, 8 Apr 2022 20:40:42 +0800 Subject: [PATCH] ring: fix description 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") Cc: stable@dpdk.org Signed-off-by: Haiyue Wang --- doc/guides/prog_guide/ring_lib.rst | 2 +- lib/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/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.