[dpdk-dev] doc: fix a typo in sample apps guide.

Message ID 1497730425-9449-1-git-send-email-rami.rosen@intel.com (mailing list archive)
State Accepted, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Rami Rosen June 17, 2017, 8:13 p.m. UTC
  This patch fixes a trivial typo in the sample apps guide. 
commit 35b09d76f89e ("doc: use corelist instead of coremask") replaced 
the usage of coremask (-c) with corelist (-l).
As a result of this patch, we have
./build/ipv4_multicast -l 0-3 -n 3 -- -p 0x3 -q 1
in the sample app guide, while the explanation immediately following
says:
In this command:
• The -c option enables cores 0, 1, 2 and 3

This patch fixes the
explanation to have "-l" instead of "-c".

Signed-off-by: Rami Rosen <rami.rosen@intel.com>
---
 doc/guides/sample_app_ug/ipv4_multicast.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

John McNamara June 26, 2017, 3:03 p.m. UTC | #1
> -----Original Message-----

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Rami Rosen

> Sent: Saturday, June 17, 2017 9:14 PM

> To: dev@dpdk.org

> Cc: Rosen, Rami <rami.rosen@intel.com>

> Subject: [dpdk-dev] [PATCH] doc: fix a typo in sample apps guide.

> 

> This patch fixes a trivial typo in the sample apps guide.

> commit 35b09d76f89e ("doc: use corelist instead of coremask") replaced the

> usage of coremask (-c) with corelist (-l).

> As a result of this patch, we have

> ./build/ipv4_multicast -l 0-3 -n 3 -- -p 0x3 -q 1 in the sample app guide,

> while the explanation immediately following

> says:

> In this command:

> • The -c option enables cores 0, 1, 2 and 3

> 

> This patch fixes the

> explanation to have "-l" instead of "-c".

> 

> Signed-off-by: Rami Rosen <rami.rosen@intel.com>


Acked-by: John McNamara <john.mcnamara@intel.com>
  
Thomas Monjalon July 1, 2017, 3:35 p.m. UTC | #2
> > This patch fixes a trivial typo in the sample apps guide.
> > commit 35b09d76f89e ("doc: use corelist instead of coremask") replaced the
> > usage of coremask (-c) with corelist (-l).
> > As a result of this patch, we have
> > ./build/ipv4_multicast -l 0-3 -n 3 -- -p 0x3 -q 1 in the sample app guide,
> > while the explanation immediately following
> > says:
> > In this command:
> > • The -c option enables cores 0, 1, 2 and 3
> > 
> > This patch fixes the
> > explanation to have "-l" instead of "-c".
> > 
> > Signed-off-by: Rami Rosen <rami.rosen@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Fixes: 35b09d76f89e ("doc: use corelist instead of coremask")
Cc: stable@dpdk.org

Applied, thanks
  

Patch

diff --git a/doc/guides/sample_app_ug/ipv4_multicast.rst b/doc/guides/sample_app_ug/ipv4_multicast.rst
index 3e30f5090e68..7d2b27e7c3ed 100644
--- a/doc/guides/sample_app_ug/ipv4_multicast.rst
+++ b/doc/guides/sample_app_ug/ipv4_multicast.rst
@@ -117,7 +117,7 @@  Typically, to run the IPv4 Multicast sample application, issue the following com
 
 In this command:
 
-*   The -c option enables cores 0, 1, 2 and 3
+*   The -l option enables cores 0, 1, 2 and 3
 
 *   The -n option specifies 3 memory channels