From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mogw0316.ocn.ad.jp (mogw0316.ocn.ad.jp [114.147.58.86]) by dpdk.org (Postfix) with ESMTP id 41FE22C12 for ; Mon, 12 Mar 2018 07:29:29 +0100 (CET) Received: from mf-smf-ucb027c2 (mf-smf-ucb027c2.ocn.ad.jp [153.153.66.170]) by mogw0316.ocn.ad.jp (Postfix) with ESMTP id C17011023D; Mon, 12 Mar 2018 15:29:27 +0900 (JST) Received: from ntt.pod01.mv-mta-ucb019 ([153.149.142.82]) by mf-smf-ucb027c2 with ESMTP id vGxWeJmigfxiGvGxbeMX8h; Mon, 12 Mar 2018 15:29:27 +0900 Received: from smtp.ocn.ne.jp ([153.149.227.167]) by ntt.pod01.mv-mta-ucb019 with id LuVT1x00F3dLKTM01uVThe; Mon, 12 Mar 2018 06:29:27 +0000 Received: from linaloe.flets-east.jp (sp1-66-103-93.msc.spmode.ne.jp [1.66.103.93]) by smtp.ocn.ne.jp (Postfix) with ESMTPA; Mon, 12 Mar 2018 15:29:27 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com Cc: Yasufumi Ogawa Date: Mon, 12 Mar 2018 15:29:01 +0900 Message-Id: <1520836145-29134-11-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1520836145-29134-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> References: <1520836145-29134-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> Subject: [spp] [PATCH 10/14] docs: update secondary 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: Mon, 12 Mar 2018 06:29:29 -0000 From: Yasufumi Ogawa Signed-off-by: Yasufumi Ogawa --- docs/guides/commands/secondary.rst | 41 ++++++++++++++------------------------ 1 file changed, 15 insertions(+), 26 deletions(-) diff --git a/docs/guides/commands/secondary.rst b/docs/guides/commands/secondary.rst index 8186e5d..d3566ad 100644 --- a/docs/guides/commands/secondary.rst +++ b/docs/guides/commands/secondary.rst @@ -53,11 +53,10 @@ Show running status and resources. .. code-block:: console spp > sec 1;status - recv:7:{Client ID 1 Idling - 1 - port id: 0,on,PHY,outport: none - port id: 1,on,PHY,outport: none - } + status: idling + ports: + - 'phy:0' + - 'phy:1' add @@ -70,27 +69,23 @@ Adding ring 0 by .. code-block:: console spp> sec 1;add ring 0 - recv:7:{addring0} Or adding vhost 0 by .. code-block:: console spp> sec 1;add vhost 0 - recv:7:{addvhost0} patch ------ Create a path between two ports, source and destination ports. -Port ID is referred by status sub commnad. This command just creates path and does not start forwarding. .. code-block:: console - spp > sec 1;patch 0 2 - recv:7:{patch02} + spp > sec 1;patch phy:0 ring:0 forward @@ -101,19 +96,17 @@ Start forwarding. .. code-block:: console spp > sec 1;forward - recv:7:{start forwarding} -Running status is changed from ``Idling`` to ``Running`` by +Running status is changed from ``idling`` to ``running`` by executing it. .. code-block:: console spp > sec 1;status - recv:7:{Client ID 1 Running - 1 - port id: 0,on,PHY,outport: none - port id: 1,on,PHY,outport: none - } + status: running + ports: + - 'phy:0' + - 'phy:1' stop @@ -124,19 +117,17 @@ Stop forwarding. .. code-block:: console spp > sec 1;stop - recv:7:{start forwarding} -Running status is changed from ``Running`` to ``Idling`` by +Running status is changed from ``running`` to ``idling`` by executing it. .. code-block:: console spp > sec 1;status - recv:7:{Client ID 1 Running - 1 - port id: 0,on,PHY,outport: none - port id: 1,on,PHY,outport: none - } + status: idling + ports: + - 'phy:0' + - 'phy:1' del @@ -147,7 +138,6 @@ Delete PMD added by ``add`` subcommand from the secondary. .. code-block:: console spp> sec 1;del ring 0 - recv:7:{delring0} exit @@ -159,4 +149,3 @@ command instead of it. .. code-block:: console spp> sec 1;exit - recv:7:{delring0} -- 2.7.4