From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw2108.ocn.ad.jp (mogw2108.ocn.ad.jp [202.234.252.10]) by dpdk.org (Postfix) with ESMTP id D7D912082 for ; Fri, 18 Jan 2019 05:01:51 +0100 (CET) Received: from mf-smf-ucb023c2 (mf-smf-ucb023c2.ocn.ad.jp [153.153.66.143]) by mogw2108.ocn.ad.jp (Postfix) with ESMTP id 29B9D420169; Fri, 18 Jan 2019 13:01:50 +0900 (JST) Received: from ocn-vc-mts-102c1.ocn.ad.jp ([153.153.66.81]) by mf-smf-ucb023c2 with ESMTP id kLFlgZFtmHcBqkLLqgm2Ay; Fri, 18 Jan 2019 13:01:50 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.135]) by ocn-vc-mts-102c1.ocn.ad.jp with ESMTP id kLLpgG4jG8o4xkLLpgKuH4; Fri, 18 Jan 2019 13:01:49 +0900 Received: from localhost.localdomain (unknown [192.47.164.146]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Fri, 18 Jan 2019 13:01:49 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp, spp@dpdk.org Date: Fri, 18 Jan 2019 13:01:48 +0900 Message-Id: <20190118040148.26846-3-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190118040148.26846-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20190118040148.26846-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 2/2] docs: revise desc of spp_mirror commands X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 18 Jan 2019 04:01:52 -0000 From: Yasufumi Ogawa * Fix incorrect examples, not `vf` but `mirror`. * Correct usage of singular and plural in some descriptions. Signed-off-by: Yasufumi Ogawa --- docs/guides/commands/secondary/spp_mirror.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/guides/commands/secondary/spp_mirror.rst b/docs/guides/commands/secondary/spp_mirror.rst index de20c1a..f81d3a9 100644 --- a/docs/guides/commands/secondary/spp_mirror.rst +++ b/docs/guides/commands/secondary/spp_mirror.rst @@ -106,7 +106,7 @@ consists of three parts. .. code-block:: console - spp > vf 1; status + spp > mirror 1; status Basic Information: - client-id: 3 - ports: [phy:0, phy:1, ring:0, ring:1, ring:2, ring:3, ring:4] @@ -146,19 +146,19 @@ cores which are reserved with ``-c`` or ``-l`` option while launching # release worker 'NAME' from the role spp > mirror SEC_ID; component stop NAME -Here is some examples of assigning roles with ``component`` command. +Here is an example of assigning role with ``component`` command. .. code-block:: console # assign 'mirror' role with name 'mr1' on core 2 spp > mirror 2; component start mr1 2 mirror -Or examples of releasing roles. +And an examples of releasing role. .. code-block:: console # release mirror role - spp > vf 2; component stop mr1 + spp > mirror 2; component stop mr1 .. _commands_spp_mirror_port: @@ -173,7 +173,7 @@ Adding port .. code-block:: console - spp > vf SEC_ID; port add RES_UID DIR NAME + spp > mirror SEC_ID; port add RES_UID DIR NAME ``RES_UID`` is with replaced with resource UID such as ``ring:0`` or ``vhost:1``. ``spp_mirror`` supports three types of port. @@ -202,14 +202,14 @@ by duplicating the packets. Deleting port ~~~~~~~~~~~~~ -Delete a port which is not used anymore. It is almost same as adding port. +Delete a port which is not be used anymore. It is almost same as adding port. .. code-block:: console spp > mirror SEC_ID; port del RES_UID DIR NAME -Here is an example. +Here is some examples. .. code-block:: console @@ -222,7 +222,7 @@ Here is an example. exit ---- -Terminate the spp_mirror. +Terminate ``spp_mirror`` process. .. code-block:: console -- 2.17.1