From: ogawa.yasufumi@lab.ntt.co.jp
To: ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp, spp@dpdk.org
Subject: [spp] [PATCH 2/2] docs: revise desc of spp_mirror commands
Date: Fri, 18 Jan 2019 13:01:48 +0900 [thread overview]
Message-ID: <20190118040148.26846-3-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <20190118040148.26846-1-ogawa.yasufumi@lab.ntt.co.jp>
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
* Fix incorrect examples, not `vf` but `mirror`.
* Correct usage of singular and plural in some descriptions.
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
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
prev parent reply other threads:[~2019-01-18 4:01 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-18 4:01 [spp] [PATCH 0/2] Update for command reference ogawa.yasufumi
2019-01-18 4:01 ` [spp] [PATCH 1/2] docs: update common commands ogawa.yasufumi
2019-01-18 4:01 ` ogawa.yasufumi [this message]
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=20190118040148.26846-3-ogawa.yasufumi@lab.ntt.co.jp \
--to=ogawa.yasufumi@lab.ntt.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=spp@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).