[dpdk-dev] doc: fix typos in ring lib

Message ID 1418128052-17208-1-git-send-email-pablo.de.lara.guarch@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

De Lara Guarch, Pablo Dec. 9, 2014, 12:27 p.m. UTC
  Ring library section in PG had a couple of typos,
in the text and in one of the images

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---
 doc/guides/prog_guide/img/ring-modulo1.svg |    2 +-
 doc/guides/prog_guide/ring_lib.rst         |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
  

Comments

Iremonger, Bernard Dec. 11, 2014, 10:10 a.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Pablo de Lara
> Sent: Tuesday, December 9, 2014 12:28 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: fix typos in ring lib
> 
> Ring library section in PG had a couple of typos, in the text and in one of the images
> 
> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

 I have applied the patch to my tree next/dpdk-doc.
  

Patch

diff --git a/doc/guides/prog_guide/img/ring-modulo1.svg b/doc/guides/prog_guide/img/ring-modulo1.svg
index 768318d..614b7bf 100644
--- a/doc/guides/prog_guide/img/ring-modulo1.svg
+++ b/doc/guides/prog_guide/img/ring-modulo1.svg
@@ -785,7 +785,7 @@ 
          sodipodi:role="line"
          x="78.791893"
          y="528.97369"
-         id="tspan5287">free_entries = (mask + ct - ph) % 65536 = 8383</tspan></text>
+         id="tspan5287">free_entries = (mask + ct - ph) % 65536 = 5383</tspan></text>
     <path
        style="fill:#5a750a;fill-opacity:1;stroke:#fd0004;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-start:url(#Arrow1Mstart);marker-end:url(#Arrow1Mend)"
        d="m 324.78109,452.09355 20.16896,0"
diff --git a/doc/guides/prog_guide/ring_lib.rst b/doc/guides/prog_guide/ring_lib.rst
index 74f143c..3289d71 100644
--- a/doc/guides/prog_guide/ring_lib.rst
+++ b/doc/guides/prog_guide/ring_lib.rst
@@ -236,7 +236,7 @@  On both cores, *ring->prod_head* and ring->cons_tail are copied in local variabl
 The prod_next local variable points to the next element of the table,
 or several elements after in the case of bulk enqueue.
 
-If there are not enough objects in the ring (this is detected by checking cons_tail), it returns an error.
+If there is not enough room in the ring (this is detected by checking cons_tail), it returns an error.
 
 .. image12_png has been replaced