[spp] [PATCH] docs: fix typos of command example

ogawa.yasufumi at lab.ntt.co.jp ogawa.yasufumi at lab.ntt.co.jp
Tue Jun 12 13:16:17 CEST 2018


From: Yasufumi Ogawa <ogawa.yasufumi at lab.ntt.co.jp>

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi at lab.ntt.co.jp>
---
 docs/guides/setup/howto_use.rst | 5 +++--
 docs/guides/setup/use_cases.rst | 6 ++++--
 2 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/docs/guides/setup/howto_use.rst b/docs/guides/setup/howto_use.rst
index dc014aa..19f7074 100644
--- a/docs/guides/setup/howto_use.rst
+++ b/docs/guides/setup/howto_use.rst
@@ -53,7 +53,8 @@ SPP controller is implemented as a python script ``spp.py``.
 
 .. code-block:: console
 
-    $ python spp.py
+    $ cd /path/to/spp
+    $ python src/spp.py
     primary port : 5555
     secondary port : 6666
     Welcome to the spp.   Type help or ? to list commands.
@@ -67,7 +68,7 @@ Please refer help message for options.
 
 .. code-block:: console
 
-    $ ./src/spp.py -h
+    $ python src/spp.py -h
     usage: spp.py [-h] [-p PRI_PORT] [-s SEC_PORT] [-m MNG_PORT] [-ip IPADDR]
 
     SPP Controller
diff --git a/docs/guides/setup/use_cases.rst b/docs/guides/setup/use_cases.rst
index 1cd30a6..2c83fe0 100644
--- a/docs/guides/setup/use_cases.rst
+++ b/docs/guides/setup/use_cases.rst
@@ -260,6 +260,7 @@ First, add ``ring 0`` and ``ring 1`` to ``sec 1``.
 
     spp > sec 1;add ring 0
     spp > sec 1;add ring 1
+    spp > sec 1;status
     status: idling
     ports:
       - 'phy:0'
@@ -274,6 +275,7 @@ Then, add ``ring 0`` and ``ring 1`` to ``sec 2``.
 
     spp > sec 2;add ring 0
     spp > sec 2;add ring 1
+    spp > sec 2;status
     status: idling
     ports:
       - 'phy:0'
@@ -326,7 +328,7 @@ creation.
     sock0 ...
 
     # remove it if exist
-    $ rm /tmp/sock0
+    $ sudo rm /tmp/sock0
 
 Create ``/tmp/sock0`` from ``sec 1``.
 
@@ -480,7 +482,7 @@ and watch received packets on pktgen.
 
 .. code-block:: console
 
-    spp > sec 2;patch phy:1 pcap:2
+    spp > sec 2;patch pcap:2 phy:1
     spp > sec 2;forward
 
 After started forwarding, you can see that packet count is increased.
-- 
2.17.1



More information about the spp mailing list