diff mbox

[dpdk-dev] doc: minor correction in document

Message ID 1454062308-19758-1-git-send-email-ferruh.yigit@intel.com (mailing list archive)
State Superseded, archived
Headers

Commit Message

Ferruh Yigit Jan. 29, 2016, 10:11 a.m. UTC 
  * 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(-)

Comments

John McNamara Feb. 1, 2016, 4:02 p.m. UTC | #1 
> -----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.
--
diff mbox

Patch

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