[spp] [PATCH 7/7] docs: fix incorrect commands in usecases.
x-fn-spp at sl.ntt-tx.co.jp
x-fn-spp at sl.ntt-tx.co.jp
Thu Jan 9 03:51:13 CET 2020
From: Hideyuki Yamashita <yamashita.hideyuki at po.ntt-tx.co.jp>
There are several incorrectness whih regards to
usecases, how to use parts.
So this patch set provides the fix.
Signed-off-by: Hideyuki Yamashita <yamashita.hideyuki at po.ntt-tx.co.jp>
Signed-off-by: Yasufumi Ogawa <yasufum.o at gmail.com>
---
docs/guides/gsg/howto_use.rst | 8 +++++---
docs/guides/usecases/multi_nodes.rst | 4 ++--
docs/guides/usecases/spp_nfv.rst | 2 +-
docs/guides/usecases/spp_vf.rst | 10 +++++-----
4 files changed, 13 insertions(+), 11 deletions(-)
diff --git a/docs/guides/gsg/howto_use.rst b/docs/guides/gsg/howto_use.rst
index 631594b..9553699 100644
--- a/docs/guides/gsg/howto_use.rst
+++ b/docs/guides/gsg/howto_use.rst
@@ -173,8 +173,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
@@ -276,7 +277,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] [--config CONFIG]
SPP Controller
@@ -284,6 +285,7 @@ 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
+ --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..f61d6e9 100644
--- a/docs/guides/usecases/multi_nodes.rst
+++ b/docs/guides/usecases/multi_nodes.rst
@@ -173,8 +173,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 f17c0dc..fda0b7d 100644
--- a/docs/guides/usecases/spp_vf.rst
+++ b/docs/guides/usecases/spp_vf.rst
@@ -194,14 +194,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.
@@ -582,8 +582,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
More information about the spp
mailing list