From: x-fn-spp-ml@ntt-tx.co.jp
To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com
Subject: [spp] [PATCH 8/8] docs: fix incorrect commands in usecases.
Date: Thu, 27 Feb 2020 18:44:22 +0900 [thread overview]
Message-ID: <20200227094422.7429-9-x-fn-spp-ml@ntt-tx.co.jp> (raw)
In-Reply-To: <20200227094422.7429-1-x-fn-spp-ml@ntt-tx.co.jp>
From: Hideyuki Yamashita <yamashita.hideyuki@po.ntt-tx.co.jp>
There are several incorrectness whih regards to
usecases, how to use parts.
So this patch set provides the fix.
Fixes: d76cb64c ("docs: update how to use section for using spp-ctl")
Fixes: 359d5a3b ("docs: add multiple nodes section in usecases")
Fixes: e3fecafd ("docs: remove spp_vm from usecases")
Fixes: 454c7ef2 ("docs: move usecase of spp_vf")
Fixes: 215c18f4 ("docs: update usecase of ssh with spp_vf")
Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki@ntt-tx.co.jp>
Signed-off-by: Naoki Takada <ntakada14@gmail.com>
---
docs/guides/gsg/howto_use.rst | 9 ++++++---
docs/guides/usecases/multi_nodes.rst | 6 ++++--
docs/guides/usecases/spp_nfv.rst | 2 +-
docs/guides/usecases/spp_vf.rst | 10 +++++-----
4 files changed, 16 insertions(+), 11 deletions(-)
diff --git a/docs/guides/gsg/howto_use.rst b/docs/guides/gsg/howto_use.rst
index 4e42c58..965b8c7 100644
--- a/docs/guides/gsg/howto_use.rst
+++ b/docs/guides/gsg/howto_use.rst
@@ -219,8 +219,9 @@ All of options can be referred with help option ``-h``.
.. code-block:: console
- python3 ./src/spp-ctl/spp-ctl -h
- usage: spp-ctl [-h] [-b BIND_ADDR] [-p PRI_PORT] [-s SEC_PORT] [-a API_PORT]
+ $ python3 ./src/spp-ctl/spp-ctl -h
+ usage: spp-ctl [-h] [-b BIND_ADDR] [-p PRI_PORT]
+ [-s SEC_PORT] [-a API_PORT]
SPP Controller
@@ -322,7 +323,7 @@ All of options can be referred with help option ``-h``.
.. code-block:: console
$ python3 src/spp.py -h
- usage: spp.py [-h] [-b BIND_ADDR] [-a API_PORT]
+ usage: spp.py [-h] [-b BIND_ADDR] [--wait-pri] [--config CONFIG]
SPP Controller
@@ -330,6 +331,8 @@ All of options can be referred with help option ``-h``.
-h, --help show this help message and exit
-b BIND_ADDR, --bind-addr BIND_ADDR
bind address, default=127.0.0.1:7777
+ --wait-pri Wait for spp_primary is launched
+ --config CONFIG Config file path
All of SPP CLI commands are described in :doc:`../../commands/index`.
diff --git a/docs/guides/usecases/multi_nodes.rst b/docs/guides/usecases/multi_nodes.rst
index 3eaed0c..e380620 100644
--- a/docs/guides/usecases/multi_nodes.rst
+++ b/docs/guides/usecases/multi_nodes.rst
@@ -156,6 +156,8 @@ For host2, swith server to host2 and run nfv commands.
Switch spp-ctl to "2: 192.168.1.102:7777".
# configure
+ spp > nfv 1; add vhost:0
+ Add vhost:0.
spp > nfv 1; patch phy:0 vhost:0
Patch ports (phy:0 -> vhost:0).
spp > nfv 1; patch vhost:0 phy:1
@@ -173,8 +175,8 @@ Finally, change path from blue lines to red lines.
.. code-block:: console
# switch to server 1
- spp > server 2
- Switch spp-ctl to "2: 192.168.1.102:7777".
+ spp > server 1
+ Switch spp-ctl to "1: 192.168.1.101:7777".
# remove blue path
spp > nfv 1; stop
diff --git a/docs/guides/usecases/spp_nfv.rst b/docs/guides/usecases/spp_nfv.rst
index cc18b08..488fdec 100644
--- a/docs/guides/usecases/spp_nfv.rst
+++ b/docs/guides/usecases/spp_nfv.rst
@@ -385,7 +385,7 @@ to confirm that network on host is configured.
.. code-block:: console
- $ sudo $RE_SDK/examples/build/l2fwd -l 0-1 -- -p 0x03
+ $ sudo $RTE_SDK/examples/build/l2fwd -l 0-1 -- -p 0x03
.. _figure_spp_nfv_l2fwd_vhost:
diff --git a/docs/guides/usecases/spp_vf.rst b/docs/guides/usecases/spp_vf.rst
index ee18439..c45feb8 100644
--- a/docs/guides/usecases/spp_vf.rst
+++ b/docs/guides/usecases/spp_vf.rst
@@ -199,14 +199,14 @@ First, delete entries of ``classifier_table`` and ports of components.
# forwarders
spp > vf 1; port del ring:0 rx fwd1
- spp > vf 1; port del vhost:0 tx fwd1
+ spp > vf 1; port del ring:2 tx fwd1
spp > vf 1; port del ring:1 rx fwd2
- spp > vf 1; port del vhost:2 tx fwd2
+ spp > vf 1; port del ring:3 tx fwd2
# mergers
spp > vf 1; port del ring:2 rx mgr
spp > vf 1; port del ring:3 rx mgr
- spp > vf 1; port del phy:0 tx mgr
+ spp > vf 1; port del phy:1 tx mgr
Then, stop components.
@@ -587,8 +587,8 @@ Delete entries from the table and ports from each of components.
spp > vf 1; port del vhost:3 tx fwd6
spp > vf 1; port del vhost:1 rx fwd7
spp > vf 1; port del ring:6 tx fwd7
- spp > vf 1; port del vhost:3 tx fwd8
- spp > vf 1; port del ring:7 rx fwd8
+ spp > vf 1; port del vhost:3 rx fwd8
+ spp > vf 1; port del ring:7 tx fwd8
# merger
spp > vf 1; port del ring:6 rx mgr2
--
2.17.1
next prev parent reply other threads:[~2020-02-27 9:44 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-27 9:44 [spp] [PATCH 0/8] Update docs and rcps x-fn-spp-ml
2020-02-27 9:44 ` [spp] [PATCH 1/8] recipes: add vhost related rcps for spp_nfv x-fn-spp-ml
2020-02-27 9:44 ` [spp] [PATCH 2/8] recipes: fix rcps for setting up spp_vf x-fn-spp-ml
2020-02-27 9:44 ` [spp] [PATCH 3/8] recipes: fix typos " x-fn-spp-ml
2020-02-27 9:44 ` [spp] [PATCH 4/8] recipes: fix rcps for shutting down spp_vf x-fn-spp-ml
2020-02-27 9:44 ` [spp] [PATCH 5/8] recipes: add rcps for spp_mirror x-fn-spp-ml
2020-02-27 9:44 ` [spp] [PATCH 6/8] recipes: add rcps for multiple_nodes x-fn-spp-ml
2020-02-27 9:44 ` [spp] [PATCH 7/8] docs: adds sample Domain XML file for vhost x-fn-spp-ml
2020-02-27 9:44 ` x-fn-spp-ml [this message]
2020-02-28 8:49 ` [spp] [PATCH 0/8] Update docs and rcps Yasufumi Ogawa
2020-03-03 9:25 ` [spp] [PATCH v2 " x-fn-spp-ml
2020-03-05 1:26 ` Yasufumi Ogawa
2020-03-03 9:25 ` [spp] [PATCH v2 1/8] recipes: add vhost related rcps for spp_nfv x-fn-spp-ml
2020-03-03 9:25 ` [spp] [PATCH v2 2/8] recipes: fix rcps for setting up spp_vf x-fn-spp-ml
2020-03-03 9:25 ` [spp] [PATCH v2 3/8] recipes: fix typos " x-fn-spp-ml
2020-03-03 9:25 ` [spp] [PATCH v2 4/8] recipes: fix rcps for shutting down spp_vf x-fn-spp-ml
2020-03-03 9:25 ` [spp] [PATCH v2 5/8] recipes: add rcps for spp_mirror x-fn-spp-ml
2020-03-03 9:25 ` [spp] [PATCH v2 6/8] recipes: add rcps for multiple_nodes x-fn-spp-ml
2020-03-03 9:25 ` [spp] [PATCH v2 7/8] docs: adds sample Domain XML file for vhost x-fn-spp-ml
2020-03-03 9:25 ` [spp] [PATCH v2 8/8] docs: fix incorrect commands in usecases x-fn-spp-ml
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=20200227094422.7429-9-x-fn-spp-ml@ntt-tx.co.jp \
--to=x-fn-spp-ml@ntt-tx.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=spp@dpdk.org \
--cc=yasufum.o@gmail.com \
/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).