[spp] [PATCH 06/15] docs: add descriptions for pri commands

ogawa.yasufumi at lab.ntt.co.jp ogawa.yasufumi at lab.ntt.co.jp
Thu Feb 1 05:04:52 CET 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/commands/primary.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/docs/guides/commands/primary.rst b/docs/guides/commands/primary.rst
index b8e5f1d..0a338e9 100644
--- a/docs/guides/commands/primary.rst
+++ b/docs/guides/commands/primary.rst
@@ -32,9 +32,14 @@
 Primary Commands
 ====================
 
+Primary process is managed with ``pri`` command.
+
+
 status
 ------
 
+Show status of primary.
+
 .. code-block:: console
 
     spp > pri status
@@ -44,15 +49,24 @@ status
 exit
 ----
 
+Terminate primary.
+
 .. code-block:: console
 
     spp > pri exit
     closing:('127.0.0.1', 50524)
 
+.. 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``.
 
 clear
 -----
 
+Clear statistics.
+
 .. code-block:: console
 
     spp > pri clear
-- 
2.7.4



More information about the spp mailing list