Soft Patch Panel
 help / color / mirror / Atom feed
From: ogawa.yasufumi@lab.ntt.co.jp
To: ferruh.yigit@intel.com, spp@dpdk.org
Cc: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Subject: [spp] [PATCH 1/3] docs: add additional common commands
Date: Tue,  6 Mar 2018 19:55:03 +0900	[thread overview]
Message-ID: <20180306105505.65486-2-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <20180306105505.65486-1-ogawa.yasufumi@lab.ntt.co.jp>

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

SPP is updated to support for basic Linux commands, such as pwd, cd and
ls.

This update is for adding the new commands to common command section.

Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
 docs/guides/commands/common.rst | 90 +++++++++++++++++++++++++++++++++++++++--
 1 file changed, 87 insertions(+), 3 deletions(-)

diff --git a/docs/guides/commands/common.rst b/docs/guides/commands/common.rst
index 719d663..ebd1fa1 100644
--- a/docs/guides/commands/common.rst
+++ b/docs/guides/commands/common.rst
@@ -43,7 +43,7 @@ It also show a list of secondary IDs
     spp > status
     Soft Patch Panel Status :
     primary: 1
-    secondary count: 4
+    secondary count: 2
     Connected secondary id: 1
     Connected secondary id: 2
 
@@ -84,6 +84,67 @@ as a config, although you can use any of extensions such as ``.txt`` or
     spp> playback 2nfv_uni.config
 
 
+pwd
+---
+
+Show current path.
+
+.. code-block:: console
+
+    spp> pwd
+    /path/to/curdir
+
+
+cd
+--
+
+Change current directory.
+
+.. code-block:: console
+
+    spp> cd /path/to/dir
+
+
+ls
+--
+
+Show a list of directory contents.
+
+.. code-block:: console
+
+    spp> ls /path/to/dir
+
+
+mkdir
+-----
+
+Make a directory.
+
+.. code-block:: console
+
+    spp> mkdir /path/to/dir
+
+
+cat
+---
+
+Show contents of a file.
+
+.. code-block:: console
+
+    spp> cat /path/to/file
+
+
+less
+----
+
+Show contents of a file.
+
+.. code-block:: console
+
+    spp> less /path/to/file
+
+
 bye
 ---
 
@@ -111,6 +172,18 @@ Second one is for all SPP processes other than controller.
     closing:('127.0.0.1', 53620)
 
 
+exit
+----
+
+Same as ``bye`` command but just for terminating SPP controller and
+not for other processes.
+
+.. code-block:: console
+
+    spp > exit
+    Thank you for using Soft Patch Panel
+
+
 help
 ----
 
@@ -122,9 +195,20 @@ Show help message for SPP commands.
 
     Documented commands (type help <topic>):
     ========================================
-    bye  help  playback  pri  record  sec  status
+    bye  cd    help  load_cmd  mkdir     pri  record  status  topo_subgraph
+    cat  exit  less  ls        playback  pwd  sec     topo
 
     spp > help status
-    Display Soft Patch Panel Status
+    Display status info of SPP processes
+
+        spp > status
+
     spp > help sec
     Send command to secondary process
+
+        SPP secondary process is specified with secondary ID and takes
+        sub commands.
+
+        spp > sec 1;status
+        spp > sec 1;add ring 0
+        spp > sec 1;patch 0 2
-- 
2.13.1

  reply	other threads:[~2018-03-06 10:55 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-03-06 10:55 [spp] [PATCH 0/3] Update documents for SPP controller ogawa.yasufumi
2018-03-06 10:55 ` ogawa.yasufumi [this message]
2018-03-06 10:55 ` [spp] [PATCH 2/3] docs: add experimental commands ogawa.yasufumi
2018-03-06 11:12   ` [spp] [PATCH v2 " ogawa.yasufumi
2018-03-06 10:55 ` [spp] [PATCH 3/3] docs: fix typo of experimental command section ogawa.yasufumi
2018-03-27 23:44 ` [spp] [PATCH 0/3] Update documents for SPP controller Ferruh Yigit

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=20180306105505.65486-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).