From: ogawa.yasufumi@lab.ntt.co.jp
To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp
Subject: [spp] [PATCH 2/4] docs: update primary command reference
Date: Thu, 11 Oct 2018 20:12:05 +0900 [thread overview]
Message-ID: <20181011111207.49604-3-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <20181011111207.49604-1-ogawa.yasufumi@lab.ntt.co.jp>
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
Update description of primary commands.
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
docs/guides/commands/primary.rst | 29 +++++++++++++++++------------
1 file changed, 17 insertions(+), 12 deletions(-)
diff --git a/docs/guides/commands/primary.rst b/docs/guides/commands/primary.rst
index 0a338e9..85c1c68 100644
--- a/docs/guides/commands/primary.rst
+++ b/docs/guides/commands/primary.rst
@@ -38,29 +38,35 @@ Primary process is managed with ``pri`` command.
status
------
-Show status of primary.
+Show forwarding statistics of each of ports.
.. code-block:: console
- spp > pri status
- recv:('127.0.0.1', 50524):{Server Running}
-
+ spp > pri; status
+ Physical Ports:
+ ID rx tx tx_drop mac_addr
+ 0 78932932 78932931 1 56:48:4f:53:54:00
+ Ring Ports:
+ ID rx tx rx_drop tx_drop
+ 0 89283 89283 0 0
+ 1 9208 9203 0 5
+ ...
exit
----
-Terminate primary.
+Terminate primary process.
.. code-block:: console
- spp > pri exit
- closing:('127.0.0.1', 50524)
+ spp > pri; exit
.. note::
- You should not use this command because terminating primary before
- secondaries may cause an error.
- You shold use ``bye`` command instead of ``pri exit``.
+ You should not use this command if one or more secondary processes
+ are still running because terminating primary before secondaries may
+ cause an error. You shold use ``bye`` command instead of
+ ``pri; exit``.
clear
-----
@@ -69,5 +75,4 @@ Clear statistics.
.. code-block:: console
- spp > pri clear
- recv:('127.0.0.1', 50524):{clear stats}
+ spp > pri; clear
--
2.7.4
next prev parent reply other threads:[~2018-10-11 11:12 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-11 11:12 [spp] [PATCH 0/4] Revise help messages of commands and documentation ogawa.yasufumi
2018-10-11 11:12 ` [spp] [PATCH 1/4] controller: revise help messages ogawa.yasufumi
2018-10-11 11:12 ` ogawa.yasufumi [this message]
2018-10-11 11:12 ` [spp] [PATCH 3/4] docs: update secondary command reference ogawa.yasufumi
2018-10-11 11:12 ` [spp] [PATCH 4/4] docs: update common " 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=20181011111207.49604-3-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).