* [spp] [PATCH 1/2] docs: update common commands
2019-01-18 4:01 [spp] [PATCH 0/2] Update for command reference ogawa.yasufumi
@ 2019-01-18 4:01 ` ogawa.yasufumi
2019-01-18 4:01 ` [spp] [PATCH 2/2] docs: revise desc of spp_mirror commands ogawa.yasufumi
1 sibling, 0 replies; 3+ messages in thread
From: ogawa.yasufumi @ 2019-01-18 4:01 UTC (permalink / raw)
To: ferruh.yigit, ogawa.yasufumi, spp
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Some of command examples are still remained old. This patch is to update
the old examples.
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
docs/guides/commands/common.rst | 55 ++++++++++++++++++++-------------
1 file changed, 34 insertions(+), 21 deletions(-)
diff --git a/docs/guides/commands/common.rst b/docs/guides/commands/common.rst
index 3763025..ec3e3f8 100644
--- a/docs/guides/commands/common.rst
+++ b/docs/guides/commands/common.rst
@@ -1,5 +1,6 @@
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2010-2014 Intel Corporation
+ Copyright(c) 2017-2019 Nippon Telegraph and Telephone Corporation
Common Commands
===============
@@ -7,17 +8,19 @@ Common Commands
status
------
-Show the number of connected primary and secondary processes.
-It also show a list of secondary IDs
+Show the status of SPP processes.
.. code-block:: console
spp > status
- Soft Patch Panel Status :
- primary: 1
- secondary count: 2
- Connected secondary id: 1
- Connected secondary id: 2
+ - spp-ctl:
+ - address: 172.30.202.151:7777
+ - primary:
+ - status: running
+ - secondary:
+ - processes:
+ 1: nfv:1
+ 2: vf:3
playback
@@ -182,17 +185,21 @@ First one is for terminating only secondary processes at once.
.. code-block:: console
spp > bye sec
- closing:<socket._socketobject object at 0x105750910>
- closing:<socket._socketobject object at 0x105750a60>
+ Closing secondary ...
+ Exit nfv 1
+ Exit vf 3.
+
Second one is for all SPP processes other than controller.
.. code-block:: console
spp > bye all
- closing:<socket._socketobject object at 0x10bd95910>
- closing:<socket._socketobject object at 0x10bd95a60>
- closing:('127.0.0.1', 53620)
+ Closing secondary ...
+ Exit nfv 1
+ Exit vf 3.
+ Closing primary ...
+ Exit primary
exit
@@ -218,20 +225,26 @@ Show help message for SPP commands.
Documented commands (type help <topic>):
========================================
- bye cd help load_cmd mkdir pri record status topo_subgraph
- cat exit less ls playback pwd sec topo
+ bye exit inspect ls nfv pwd server topo_resize
+ cat help less mirror playback record status topo_subgraph
+ cd history load_cmd mkdir pri redo topo vf
spp > help status
Display status info of SPP processes
spp > status
- spp > help sec
- Send command to secondary process
+ spp > help nfv
+ Send a command to spp_nfv specified with ID.
+
+ Spp_nfv is specified with secondary ID and takes sub commands.
+
+ spp > nfv 1; status
+ spp > nfv 1; add ring:0
+ spp > nfv 1; patch phy:0 ring:0
- SPP secondary process is specified with secondary ID and takes
- sub commands.
+ You can refer all of sub commands by pressing TAB after
+ 'nfv 1;'.
- spp > sec 1;status
- spp > sec 1;add ring 0
- spp > sec 1;patch 0 2
+ spp > nfv 1; # press TAB
+ add del exit forward patch status stop
--
2.17.1
^ permalink raw reply [flat|nested] 3+ messages in thread* [spp] [PATCH 2/2] docs: revise desc of spp_mirror commands
2019-01-18 4:01 [spp] [PATCH 0/2] Update for command reference ogawa.yasufumi
2019-01-18 4:01 ` [spp] [PATCH 1/2] docs: update common commands ogawa.yasufumi
@ 2019-01-18 4:01 ` ogawa.yasufumi
1 sibling, 0 replies; 3+ messages in thread
From: ogawa.yasufumi @ 2019-01-18 4:01 UTC (permalink / raw)
To: ferruh.yigit, ogawa.yasufumi, spp
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
* Fix incorrect examples, not `vf` but `mirror`.
* Correct usage of singular and plural in some descriptions.
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
docs/guides/commands/secondary/spp_mirror.rst | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/docs/guides/commands/secondary/spp_mirror.rst b/docs/guides/commands/secondary/spp_mirror.rst
index de20c1a..f81d3a9 100644
--- a/docs/guides/commands/secondary/spp_mirror.rst
+++ b/docs/guides/commands/secondary/spp_mirror.rst
@@ -106,7 +106,7 @@ consists of three parts.
.. code-block:: console
- spp > vf 1; status
+ spp > mirror 1; status
Basic Information:
- client-id: 3
- ports: [phy:0, phy:1, ring:0, ring:1, ring:2, ring:3, ring:4]
@@ -146,19 +146,19 @@ cores which are reserved with ``-c`` or ``-l`` option while launching
# release worker 'NAME' from the role
spp > mirror SEC_ID; component stop NAME
-Here is some examples of assigning roles with ``component`` command.
+Here is an example of assigning role with ``component`` command.
.. code-block:: console
# assign 'mirror' role with name 'mr1' on core 2
spp > mirror 2; component start mr1 2 mirror
-Or examples of releasing roles.
+And an examples of releasing role.
.. code-block:: console
# release mirror role
- spp > vf 2; component stop mr1
+ spp > mirror 2; component stop mr1
.. _commands_spp_mirror_port:
@@ -173,7 +173,7 @@ Adding port
.. code-block:: console
- spp > vf SEC_ID; port add RES_UID DIR NAME
+ spp > mirror SEC_ID; port add RES_UID DIR NAME
``RES_UID`` is with replaced with resource UID such as ``ring:0`` or
``vhost:1``. ``spp_mirror`` supports three types of port.
@@ -202,14 +202,14 @@ by duplicating the packets.
Deleting port
~~~~~~~~~~~~~
-Delete a port which is not used anymore. It is almost same as adding port.
+Delete a port which is not be used anymore. It is almost same as adding port.
.. code-block:: console
spp > mirror SEC_ID; port del RES_UID DIR NAME
-Here is an example.
+Here is some examples.
.. code-block:: console
@@ -222,7 +222,7 @@ Here is an example.
exit
----
-Terminate the spp_mirror.
+Terminate ``spp_mirror`` process.
.. code-block:: console
--
2.17.1
^ permalink raw reply [flat|nested] 3+ messages in thread