[dpdk-dev] doc: added missing new EAL options in testpmd UG

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

Commit Message

De Lara Guarch, Pablo March 27, 2015, 4:50 p.m. UTC
  Added information on testpmd user guide
for -l, --lcores and --master-lcore options

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---
 doc/guides/testpmd_app_ug/run_app.rst |   23 +++++++++++++++++++++++
 1 files changed, 23 insertions(+), 0 deletions(-)
  

Comments

Siobhan Butler March 27, 2015, 4:57 p.m. UTC | #1
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Pablo de Lara
> Sent: Friday, March 27, 2015 4:50 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: added missing new EAL options in testpmd
> UG
> 
> Added information on testpmd user guide
> for -l, --lcores and --master-lcore options
> 
> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> ---
>  doc/guides/testpmd_app_ug/run_app.rst |   23
> +++++++++++++++++++++++
>  1 files changed, 23 insertions(+), 0 deletions(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/run_app.rst
> b/doc/guides/testpmd_app_ug/run_app.rst
> index 3898e67..21e6c27 100644
> --- a/doc/guides/testpmd_app_ug/run_app.rst
> +++ b/doc/guides/testpmd_app_ug/run_app.rst
> @@ -42,6 +42,29 @@ See the DPDK Getting Started Guide for more
> information on these options.
> 
>      Set the hexadecimal bitmask of the cores to run on.
> 
> +*   -l CORELIST
> +
> +    List of cores to run on
> +
> +    The argument format is <c1>[-c2][,c3[-c4],...]
> +    where c1, c2, etc are core indexes between 0 and 128
> +
> +*   --lcores COREMAP
> +
> +    Map lcore set to physical cpu set
> +
> +    The argument format is
> +        '<lcores[@cpus]>[<,lcores[@cpus]>...]'
> +    lcores and cpus list are grouped by '(' and ')'
> +    Within the group, '-' is used for range separator,
> +    ',' is used for single number separator.
> +    '( )' can be omitted for single element group,
> +    '@' can be omitted if cpus and lcores have the same value
> +
> +*   --master-lcore ID
> +
> +    Core ID that is used as master
> +
>  *   -n NUM
> 
>      Set the number of memory channels to use.
> --
> 1.7.4.1

Acked-by Siobhan Butler <siobhan.a.butler@intel.com>
  
Thomas Monjalon March 31, 2015, 12:09 a.m. UTC | #2
> > Added information on testpmd user guide
> > for -l, --lcores and --master-lcore options
> > 
> > Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> 
> Acked-by Siobhan Butler <siobhan.a.butler@intel.com>

There is a small error:
doc/guides/testpmd_app_ug/run_app.rst:58: WARNING: Definition list ends
without a blank line; unexpected unindent.

Applied with small fix, thanks
  

Patch

diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
index 3898e67..21e6c27 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -42,6 +42,29 @@  See the DPDK Getting Started Guide for more information on these options.
 
     Set the hexadecimal bitmask of the cores to run on.
 
+*   -l CORELIST
+
+    List of cores to run on
+
+    The argument format is <c1>[-c2][,c3[-c4],...]
+    where c1, c2, etc are core indexes between 0 and 128
+
+*   --lcores COREMAP
+
+    Map lcore set to physical cpu set
+
+    The argument format is
+        '<lcores[@cpus]>[<,lcores[@cpus]>...]'
+    lcores and cpus list are grouped by '(' and ')'
+    Within the group, '-' is used for range separator,
+    ',' is used for single number separator.
+    '( )' can be omitted for single element group,
+    '@' can be omitted if cpus and lcores have the same value
+
+*   --master-lcore ID
+
+    Core ID that is used as master
+
 *   -n NUM
 
     Set the number of memory channels to use.