From: ogawa.yasufumi@lab.ntt.co.jp
To: ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp, spp@dpdk.org
Subject: [spp] [PATCH 1/2] docs: update common commands
Date: Fri, 18 Jan 2019 13:01:47 +0900 [thread overview]
Message-ID: <20190118040148.26846-2-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <20190118040148.26846-1-ogawa.yasufumi@lab.ntt.co.jp>
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
next prev parent reply other threads:[~2019-01-18 4:01 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-01-18 4:01 [spp] [PATCH 0/2] Update for command reference ogawa.yasufumi
2019-01-18 4:01 ` ogawa.yasufumi [this message]
2019-01-18 4:01 ` [spp] [PATCH 2/2] docs: revise desc of spp_mirror commands ogawa.yasufumi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190118040148.26846-2-ogawa.yasufumi@lab.ntt.co.jp \
--to=ogawa.yasufumi@lab.ntt.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=spp@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).