From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id C3060A056B for ; Tue, 3 Mar 2020 10:25:33 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id BAD9F3B5; Tue, 3 Mar 2020 10:25:33 +0100 (CET) Received: from dish-sg.nttdocomo.co.jp (dish-sg.nttdocomo.co.jp [202.19.227.74]) by dpdk.org (Postfix) with ESMTP id 0D6B81C01F for ; Tue, 3 Mar 2020 10:25:32 +0100 (CET) X-dD-Source: Outbound Received: from zssg-mailmd103.ddreams.local (zssg-mailmd900.ddreams.local [10.160.172.63]) by zssg-mailou102.ddreams.local (Postfix) with ESMTP id 4F992120111; Tue, 3 Mar 2020 18:25:31 +0900 (JST) Received: from zssg-mailmf104.ddreams.local (zssg-mailmf900.ddreams.local [10.160.172.84]) by zssg-mailmd103.ddreams.local (dDREAMS) with ESMTP id <0Q6M00CLQ26JMSF0@dDREAMS>; Tue, 03 Mar 2020 18:25:31 +0900 (JST) Received: from zssg-mailmf104.ddreams.local (unknown [127.0.0.1]) by zssg-mailmf104.ddreams.local (Postfix) with ESMTP id 26A897E603A; Tue, 3 Mar 2020 18:25:31 +0900 (JST) Received: from zssg-mailmf104.ddreams.local (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 2553C8E6063; Tue, 3 Mar 2020 18:25:31 +0900 (JST) Received: from localhost (unknown [127.0.0.1]) by IMSVA (Postfix) with SMTP id 240318E6060; Tue, 3 Mar 2020 18:25:31 +0900 (JST) X-IMSS-HAND-OFF-DIRECTIVE: localhost:10026 Received: from zssg-mailmf104.ddreams.local (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 6620C8E6066; Tue, 3 Mar 2020 18:25:30 +0900 (JST) Received: from davinci.ntt-tx.co.jp (unknown [10.160.183.139]) by zssg-mailmf104.ddreams.local (Postfix) with ESMTP; Tue, 3 Mar 2020 18:25:30 +0900 (JST) From: x-fn-spp-ml@ntt-tx.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com Date: Tue, 03 Mar 2020 18:25:21 +0900 Message-id: <20200303092521.22882-9-x-fn-spp-ml@ntt-tx.co.jp> X-Mailer: git-send-email 2.18.0 In-reply-to: <20200227094422.7429-1-x-fn-spp-ml@ntt-tx.co.jp> References: <20200227094422.7429-1-x-fn-spp-ml@ntt-tx.co.jp> X-TM-AS-GCONF: 00 Subject: [spp] [PATCH v2 8/8] docs: fix incorrect commands in usecases. 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: , Errors-To: spp-bounces@dpdk.org Sender: "spp" From: Hideyuki Yamashita 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 Signed-off-by: Naoki Takada --- 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