From patchwork Tue Feb 2 13:11:48 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ferruh Yigit X-Patchwork-Id: 10318 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 7243B95CE; Tue, 2 Feb 2016 14:11:56 +0100 (CET) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id F029395C8 for ; Tue, 2 Feb 2016 14:11:53 +0100 (CET) Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by fmsmga103.fm.intel.com with ESMTP; 02 Feb 2016 05:11:53 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.22,384,1449561600"; d="scan'208";a="894657815" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by fmsmga001.fm.intel.com with ESMTP; 02 Feb 2016 05:11:51 -0800 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id u12DBpdR011551; Tue, 2 Feb 2016 13:11:51 GMT Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id u12DBpWi005247; Tue, 2 Feb 2016 13:11:51 GMT Received: (from fyigit@localhost) by sivswdev02.ir.intel.com with id u12DBpnG005243; Tue, 2 Feb 2016 13:11:51 GMT From: Ferruh Yigit To: dev@dpdk.org Date: Tue, 2 Feb 2016 13:11:48 +0000 Message-Id: <1454418708-5213-1-git-send-email-ferruh.yigit@intel.com> X-Mailer: git-send-email 1.7.4.1 In-Reply-To: <20160202125934.GA11000@sivlogin002.ir.intel.com> References: <20160202125934.GA11000@sivlogin002.ir.intel.com> Subject: [dpdk-dev] [PATCH v2] doc: minor correction in document X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" * 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 --- 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 ` 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::