DPDK patches and discussions
 help / color / mirror / Atom feed
From: Ferruh Yigit <ferruh.yigit@intel.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH] doc: minor correction in document
Date: Fri, 29 Jan 2016 10:11:48 +0000	[thread overview]
Message-ID: <1454062308-19758-1-git-send-email-ferruh.yigit@intel.com> (raw)

* 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

             reply	other threads:[~2016-01-29 10:11 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-01-29 10:11 Ferruh Yigit [this message]
2016-02-01 16:02 ` Mcnamara, John
2016-02-02 12:59   ` Yigit, Ferruh
2016-02-02 13:11     ` [dpdk-dev] [PATCH v2] " Ferruh Yigit
2016-02-09 11:12       ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1454062308-19758-1-git-send-email-ferruh.yigit@intel.com \
    --to=ferruh.yigit@intel.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).