diff mbox

[dpdk-dev] doc: fix consumer/producer mixup in Ring lib doc

Message ID 1468316683-2184-1-git-send-email-shreyansh.jain@nxp.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

Shreyansh Jain July 12, 2016, 9:44 a.m. UTC 
  Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
---
 doc/guides/prog_guide/ring_lib.rst | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

Comments

John McNamara July 15, 2016, 9:37 a.m. UTC | #1 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Shreyansh Jain
> Sent: Tuesday, July 12, 2016 10:45 AM
> To: olivier.matz@6wind.com
> Cc: dev@dpdk.org; thomas.monjalon@6wind.com
> Subject: [dpdk-dev] [PATCH] doc: fix consumer/producer mixup in Ring lib
> doc
> 
> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>

Thanks. It is strange that it has gone unnoticed for so long.

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon July 16, 2016, 2:40 p.m. UTC | #2 
> > Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
> 
> Thanks. It is strange that it has gone unnoticed for so long.
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied with title underline fixes, thanks
diff mbox

Patch

diff --git a/doc/guides/prog_guide/ring_lib.rst b/doc/guides/prog_guide/ring_lib.rst
index 3b92a8f..5cf4ce2 100644
--- a/doc/guides/prog_guide/ring_lib.rst
+++ b/doc/guides/prog_guide/ring_lib.rst
@@ -252,7 +252,7 @@  In this example, only the producer head and tail (prod_head and prod_tail) are m
 
 The initial state is to have a prod_head and prod_tail pointing at the same location.
 
-Multiple Consumer Enqueue First Step
+Multiple Producers Enqueue First Step
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 On both cores, *ring->prod_head* and ring->cons_tail are copied in local variables.
@@ -266,10 +266,10 @@  If there is not enough room in the ring (this is detected by checking cons_tail)
 
 .. figure:: img/ring-mp-enqueue1.*
 
-   Multiple consumer enqueue first step
+   Multiple producer enqueue first step
 
 
-Multiple Consumer Enqueue Second Step
+Multiple Producers Enqueue Second Step
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The second step is to modify ring->prod_head in the ring structure to point to the same location as prod_next.
@@ -288,10 +288,10 @@  In the figure, the operation succeeded on core 1, and step one restarted on core
 
 .. figure:: img/ring-mp-enqueue2.*
 
-   Multiple consumer enqueue second step
+   Multiple producer enqueue second step
 
 
-Multiple Consumer Enqueue Third Step
+Multiple Producers Enqueue Third Step
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The CAS operation is retried on core 2 with success.
@@ -303,10 +303,10 @@  The core 1 updates one element of the ring(obj4), and the core 2 updates another
 
 .. figure:: img/ring-mp-enqueue3.*
 
-   Multiple consumer enqueue third step
+   Multiple producer enqueue third step
 
 
-Multiple Consumer Enqueue Fourth Step
+Multiple Producers Enqueue Fourth Step
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Each core now wants to update ring->prod_tail.
@@ -318,10 +318,10 @@  This is only true on core 1. The operation is finished on core 1.
 
 .. figure:: img/ring-mp-enqueue4.*
 
-   Multiple consumer enqueue fourth step
+   Multiple producer enqueue fourth step
 
 
-Multiple Consumer Enqueue Last Step
+Multiple Producers Enqueue Last Step
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Once ring->prod_tail is updated by core 1, core 2 is allowed to update it too.
@@ -332,7 +332,7 @@  The operation is also finished on core 2.
 
 .. figure:: img/ring-mp-enqueue5.*
 
-   Multiple consumer enqueue last step
+   Multiple producer enqueue last step
 
 
 Modulo 32-bit Indexes