From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw2401.ocn.ad.jp (mogw2401.ocn.ad.jp [202.234.255.3]) by dpdk.org (Postfix) with ESMTP id B7CE714EC for ; Fri, 18 Jan 2019 05:01:51 +0100 (CET) Received: from mf-smf-ucb021c1 (mf-smf-ucb021c1.ocn.ad.jp [153.153.66.136]) by mogw2401.ocn.ad.jp (Postfix) with ESMTP id ECD1C2C0458; Fri, 18 Jan 2019 13:01:49 +0900 (JST) Received: from ocn-vc-mts-103c1.ocn.ad.jp ([153.138.237.78]) by mf-smf-ucb021c1 with ESMTP id kLDvgpTAg3dVGkLLpgOVdZ; Fri, 18 Jan 2019 13:01:49 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.135]) by ocn-vc-mts-103c1.ocn.ad.jp with ESMTP id kLLpgrjULxmywkLLpgHKdj; Fri, 18 Jan 2019 13:01:49 +0900 Received: from localhost.localdomain (unknown [192.47.164.146]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Fri, 18 Jan 2019 13:01:49 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp, spp@dpdk.org Date: Fri, 18 Jan 2019 13:01:47 +0900 Message-Id: <20190118040148.26846-2-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20190118040148.26846-1-ogawa.yasufumi@lab.ntt.co.jp> References: <20190118040148.26846-1-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 1/2] docs: update common 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: Fri, 18 Jan 2019 04:01:52 -0000 From: Yasufumi Ogawa Some of command examples are still remained old. This patch is to update the old examples. Signed-off-by: Yasufumi Ogawa --- 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: - closing: + 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: - closing: - 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 ): ======================================== - 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