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 AC030A04FA for ; Thu, 9 Jan 2020 03:52:52 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 2D91F1DA26; Thu, 9 Jan 2020 03:52:52 +0100 (CET) Received: from mail04.ics.ntt-tx.co.jp (mail05.ics.ntt-tx.co.jp [210.232.35.69]) by dpdk.org (Postfix) with ESMTP id 35A861D697 for ; Thu, 9 Jan 2020 03:52:49 +0100 (CET) Received: from gwchk03.silk.ntt-tx.co.jp (gwchk03.silk.ntt-tx.co.jp [10.107.0.111]) by mail04.ics.ntt-tx.co.jp (unknown) with ESMTP id 0092qm67006539; Thu, 9 Jan 2020 11:52:49 +0900 Received: (from root@localhost) by gwchk03.silk.ntt-tx.co.jp (unknown) id 0092qmPN006455; Thu, 9 Jan 2020 11:52:48 +0900 Received: from gwchk.silk.ntt-tx.co.jp [10.107.0.110] by gwchk03.silk.ntt-tx.co.jp with ESMTP id MAA06260; Thu, 9 Jan 2020 11:51:13 +0900 Received: from imss04.silk.ntt-tx.co.jp (localhost [127.0.0.1]) by imss01.silk.ntt-tx.co.jp (unknown) with ESMTP id 0092pDIg027729; Thu, 9 Jan 2020 11:51:13 +0900 Received: from mgate02.silk.ntt-tx.co.jp (smtp02.silk.ntt-tx.co.jp [10.107.0.37]) by imss04.silk.ntt-tx.co.jp (unknown) with ESMTP id 0092pD8a027726; Thu, 9 Jan 2020 11:51:13 +0900 Message-Id: <202001090251.0092pD8a027726@imss04.silk.ntt-tx.co.jp> Received: from localhost by mgate02.silk.ntt-tx.co.jp (unknown) id 0092pDlA004326 ; Thu, 9 Jan 2020 11:51:13 +0900 From: x-fn-spp@sl.ntt-tx.co.jp To: ferruh.yigit@intel.com, yasufum.o@gmail.com Cc: spp@dpdk.org Date: Thu, 9 Jan 2020 11:51:13 +0900 X-Mailer: git-send-email 2.18.0 In-Reply-To: <20200109025113.22689-1-x-fn-spp@sl.ntt-tx.co.jp> References: <20200109025113.22689-1-x-fn-spp@sl.ntt-tx.co.jp> X-TM-AS-GCONF: 00 Subject: [spp] [PATCH 7/7] 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. Signed-off-by: Hideyuki Yamashita Signed-off-by: Yasufumi Ogawa --- 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