d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

ring: fix description

Browse Source 
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: 4a22e6ee3d ("doc: refactor figure numbers into references")
Fixes: af75078fec ("first public release")
Cc: stable@dpdk.org

Signed-off-by: Haiyue Wang <haiyue.wang@intel.com>
This commit is contained in:
Haiyue Wang 2022-04-08 20:40:42 +08:00 committed by Thomas Monjalon
parent 5135eedeea
commit a2248c87e2
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/guides/prog_guide/ring_lib.rst
View File

@ -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

4
lib/ring/rte_ring_core.h
View File

@ -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.