From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw0332.ocn.ad.jp (mogw0332.ocn.ad.jp [114.147.58.102]) by dpdk.org (Postfix) with ESMTP id DD1BD1B8A7 for ; Thu, 1 Feb 2018 05:05:00 +0100 (CET) Received: from mf-smf-ucb020c1 (mf-smf-ucb020c1.ocn.ad.jp [153.153.66.133]) by mogw0332.ocn.ad.jp (Postfix) with ESMTP id 6F31D2C424D; Thu, 1 Feb 2018 13:04:59 +0900 (JST) Received: from ntt.pod01.mv-mta-ucb019 ([153.149.142.82]) by mf-smf-ucb020c1 with ESMTP id h67Les0QhUyvsh67PeQOnb; Thu, 01 Feb 2018 13:04:59 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.166]) by ntt.pod01.mv-mta-ucb019 with id 5G4y1x0033c2f7501G4y5L; Thu, 01 Feb 2018 04:04:59 +0000 Received: from localhost.localdomain (sp1-66-99-86.msc.spmode.ne.jp [1.66.99.86]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Thu, 1 Feb 2018 13:04:57 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com Cc: Yasufumi Ogawa Date: Thu, 1 Feb 2018 13:04:52 +0900 Message-Id: <20180201040501.8004-6-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.13.1 In-Reply-To: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20180201040501.8004-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 06/15] docs: add descriptions for pri commands X-BeenThere: spp@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: Soft Patch Panel List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 01 Feb 2018 04:05:01 -0000 From: Yasufumi Ogawa Signed-off-by: Yasufumi Ogawa --- 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