[dpdk-dev] [PATCH] doc: minor correction in document

[dpdk-dev] [PATCH] doc: minor correction in document

[Ferruh Yigit]

* remove outdated chapter reference to Multi-process support
  Fixes: fc1f2750a3ec ("doc: programmers guide")

* html output converts "--" to "-", this is wrong when explaining the
  command arguments, used "option list" to fix this:
  http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 doc/guides/prog_guide/env_abstraction_layer.rst | 2 +-
 doc/guides/prog_guide/multi_proc_support.rst    | 5 ++---
 2 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst
index 89feb69..4737dc2 100644
--- a/doc/guides/prog_guide/env_abstraction_layer.rst
+++ b/doc/guides/prog_guide/env_abstraction_layer.rst
@@ -103,7 +103,7 @@ Multi-process Support
 ~~~~~~~~~~~~~~~~~~~~~
 
 The Linuxapp EAL allows a multi-process as well as a multi-threaded (pthread) deployment model.
-See chapter 2.20
+See chapter
 :ref:`Multi-process Support <Multi-process_Support>` for more details.
 
 Memory Mapping Discovery and Memory Reservation
diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst
index 6562f0d..1478a13 100644
--- a/doc/guides/prog_guide/multi_proc_support.rst
+++ b/doc/guides/prog_guide/multi_proc_support.rst
@@ -55,9 +55,8 @@ after a primary process has already configured the hugepage shared memory for th
 To support these two process types, and other multi-process setups described later,
 two additional command-line parameters are available to the EAL:
 
-*   --proc-type: for specifying a given process instance as the primary or secondary DPDK instance
-
-*   --file-prefix: to allow processes that do not want to co-operate to have different memory regions
+ --proc-type        for specifying a given process instance as the primary or secondary DPDK instance
+ --file-prefix      to allow processes that do not want to co-operate to have different memory regions
 
 A number of example applications are provided that demonstrate how multiple DPDK processes can be used together.
 These are more fully documented in the "Multi- process Sample Application" chapter
-- 
2.5.0

Re: [dpdk-dev] [PATCH] doc: minor correction in document

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
> Sent: Friday, January 29, 2016 10:12 AM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: minor correction in document
> 
> ...
>
> * html output converts "--" to "-", this is wrong when explaining the
>   command arguments, used "option list" to fix this:
> 
> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-
> lists

Hi Ferruh,

That is interesting. I wasn't aware of that option. That would make the documentation
of commandline options very clean.

However, it doesn't render as wrapped text in the Html output and has scroll bars instead.
This make it a little hard to read.

Maybe as a workaround we could just use fixed width quotes like other places in the docs.
Like this:


 * ``--proc-type``:        for specifying a given process ...
 * ``--file-prefix``:      to allow processes that do not ...

John.
-- 

Re: [dpdk-dev] [PATCH] doc: minor correction in document

[Yigit, Ferruh]

On Mon, Feb 01, 2016 at 04:02:05PM +0000, Mcnamara, John wrote:
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
> > Sent: Friday, January 29, 2016 10:12 AM
> > To: dev@dpdk.org
> > Subject: [dpdk-dev] [PATCH] doc: minor correction in document
> > 
> > ...
> >
> > * html output converts "--" to "-", this is wrong when explaining the
> >   command arguments, used "option list" to fix this:
> > 
> > http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-
> > lists
> 
> Hi Ferruh,
> 
> That is interesting. I wasn't aware of that option. That would make the documentation
> of commandline options very clean.
> 
> However, it doesn't render as wrapped text in the Html output and has scroll bars instead.
> This make it a little hard to read.
> 
> Maybe as a workaround we could just use fixed width quotes like other places in the docs.
> Like this:
> 
> 
>  * ``--proc-type``:        for specifying a given process ...
>  * ``--file-prefix``:      to allow processes that do not ...
> 
Thank you for the workaround, I will update according.

Thanks,
ferruh

[dpdk-dev] [PATCH v2] doc: minor correction in document

[Ferruh Yigit]

* remove outdated chapter reference to Multi-process support.
  Fixes: fc1f2750a3ec ("doc: programmers guide")

* html output converts "--" to "-", this is wrong when explaining the
  command arguments, used fixed width quotes for them.

v2:
* for "--" use fixed width quotes instead of option list.
* expand fixed width quotes usage to other "--" use cases.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
 doc/guides/prog_guide/env_abstraction_layer.rst |  2 +-
 doc/guides/prog_guide/multi_proc_support.rst    | 16 ++++++++--------
 2 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/doc/guides/prog_guide/env_abstraction_layer.rst b/doc/guides/prog_guide/env_abstraction_layer.rst
index 89feb69..4737dc2 100644
--- a/doc/guides/prog_guide/env_abstraction_layer.rst
+++ b/doc/guides/prog_guide/env_abstraction_layer.rst
@@ -103,7 +103,7 @@ Multi-process Support
 ~~~~~~~~~~~~~~~~~~~~~
 
 The Linuxapp EAL allows a multi-process as well as a multi-threaded (pthread) deployment model.
-See chapter 2.20
+See chapter
 :ref:`Multi-process Support <Multi-process_Support>` for more details.
 
 Memory Mapping Discovery and Memory Reservation
diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst
index 6562f0d..1680d6b 100644
--- a/doc/guides/prog_guide/multi_proc_support.rst
+++ b/doc/guides/prog_guide/multi_proc_support.rst
@@ -55,9 +55,9 @@ after a primary process has already configured the hugepage shared memory for th
 To support these two process types, and other multi-process setups described later,
 two additional command-line parameters are available to the EAL:
 
-*   --proc-type: for specifying a given process instance as the primary or secondary DPDK instance
+*   ``--proc-type:`` for specifying a given process instance as the primary or secondary DPDK instance
 
-*   --file-prefix: to allow processes that do not want to co-operate to have different memory regions
+*   ``--file-prefix:`` to allow processes that do not want to co-operate to have different memory regions
 
 A number of example applications are provided that demonstrate how multiple DPDK processes can be used together.
 These are more fully documented in the "Multi- process Sample Application" chapter
@@ -90,7 +90,7 @@ and point to the same objects, in both processes.
    Memory Sharing in the DPDK Multi-process Sample Application
 
 
-The EAL also supports an auto-detection mode (set by EAL --proc-type=auto flag ),
+The EAL also supports an auto-detection mode (set by EAL ``--proc-type=auto`` flag ),
 whereby an DPDK process is started as a secondary instance if a primary instance is already running.
 
 Deployment Models
@@ -102,8 +102,8 @@ Symmetric/Peer Processes
 DPDK multi-process support can be used to create a set of peer processes where each process performs the same workload.
 This model is equivalent to having multiple threads each running the same main-loop function,
 as is done in most of the supplied DPDK sample applications.
-In this model, the first of the processes spawned should be spawned using the --proc-type=primary EAL flag,
-while all subsequent instances should be spawned using the --proc-type=secondary flag.
+In this model, the first of the processes spawned should be spawned using the ``--proc-type=primary`` EAL flag,
+while all subsequent instances should be spawned using the ``--proc-type=secondary`` flag.
 
 The simple_mp and symmetric_mp sample applications demonstrate this usage model.
 They are described in the "Multi-process Sample Application" chapter in the *DPDK Sample Application's User Guide*.
@@ -125,7 +125,7 @@ Running Multiple Independent DPDK Applications
 In addition to the above scenarios involving multiple DPDK processes working together,
 it is possible to run multiple DPDK processes side-by-side,
 where those processes are all working independently.
-Support for this usage scenario is provided using the --file-prefix parameter to the EAL.
+Support for this usage scenario is provided using the ``--file-prefix`` parameter to the EAL.
 
 By default, the EAL creates hugepage files on each hugetlbfs filesystem using the rtemap_X filename,
 where X is in the range 0 to the maximum number of hugepages -1.
@@ -137,7 +137,7 @@ The rte part of the filenames of each of the above is configurable using the fil
 In addition to specifying the file-prefix parameter,
 any DPDK applications that are to be run side-by-side must explicitly limit their memory use.
 This is done by passing the -m flag to each process to specify how much hugepage memory, in megabytes,
-each process can use (or passing --socket-mem to specify how much hugepage memory on each socket each process can use).
+each process can use (or passing ``--socket-mem`` to specify how much hugepage memory on each socket each process can use).
 
 .. note::
 
@@ -149,7 +149,7 @@ Running Multiple Independent Groups of DPDK Applications
 
 In the same way that it is possible to run independent DPDK applications side- by-side on a single system,
 this can be trivially extended to multi-process groups of DPDK applications running side-by-side.
-In this case, the secondary processes must use the same --file-prefix parameter
+In this case, the secondary processes must use the same ``--file-prefix`` parameter
 as the primary process whose shared memory they are connecting to.
 
 .. note::
-- 
2.5.0

Re: [dpdk-dev] [PATCH v2] doc: minor correction in document

[Thomas Monjalon]

2016-02-02 13:11, Ferruh Yigit:
> * remove outdated chapter reference to Multi-process support.
>   Fixes: fc1f2750a3ec ("doc: programmers guide")
> 
> * html output converts "--" to "-", this is wrong when explaining the
>   command arguments, used fixed width quotes for them.
> 
> v2:
> * for "--" use fixed width quotes instead of option list.
> * expand fixed width quotes usage to other "--" use cases.
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied, thanks