From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama500.ecl.ntt.co.jp (tama500.ecl.ntt.co.jp [129.60.39.148]) by dpdk.org (Postfix) with ESMTP id 7F0401B43A for ; Thu, 31 Jan 2019 12:05:35 +0100 (CET) Received: from vc1.ecl.ntt.co.jp (vc1.ecl.ntt.co.jp [129.60.86.153]) by tama500.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id x0VB5YDL030169; Thu, 31 Jan 2019 20:05:34 +0900 Received: from vc1.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 6D33FEA8475; Thu, 31 Jan 2019 20:05:34 +0900 (JST) Received: from localhost.localdomain (lobster.nslab.ecl.ntt.co.jp [129.60.13.95]) by vc1.ecl.ntt.co.jp (Postfix) with ESMTP id 5FD70EA8457; Thu, 31 Jan 2019 20:05:34 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: ferruh.yigit@intel.com, spp@dpdk.org, ogawa.yasufumi@lab.ntt.co.jp Date: Thu, 31 Jan 2019 20:03:26 +0900 Message-Id: <1548932606-21213-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.7.4 X-TM-AS-MML: disable Subject: [spp] [PATCH] docs: update pri command 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, 31 Jan 2019 11:05:36 -0000 From: Yasufumi Ogawa This patch is to add command examples for `launch` command added in previous. It also adds an example of help message. Signed-off-by: Yasufumi Ogawa --- docs/guides/commands/primary.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/guides/commands/primary.rst b/docs/guides/commands/primary.rst index 5032b37..687484d 100644 --- a/docs/guides/commands/primary.rst +++ b/docs/guides/commands/primary.rst @@ -6,6 +6,34 @@ Primary Commands Primary process is managed with ``pri`` command. +``pri`` command takes a sub command. They must be separated with delimiter +``;``. Some of sub commands take additional arguments. + +.. code-block:: console + + spp > pri; SUB_CMD + +All of Sub commands are referred with ``help`` command. + +.. code-block:: console + + spp > help pri + Send a command to primary process. + + Show resources and statistics, or clear it. + + spp > pri; status # show status + + spp > pri; clear # clear statistics + + Launch secondary process.. + + # Launch nfv:1 + spp > pri; launch nfv 1 -l 1,2 -m 512 -- -n 1 -s 192.168.... + + # Launch vf:2 + spp > pri; launch vf 2 -l 1,4-7 -m 512 -- --client-id 2 -s ... + status ------ @@ -25,6 +53,7 @@ Show status fo spp_primary and forwarding statistics of each of ports. ID rx tx rx_drop rx_drop 0 0 0 0 0 1 0 0 0 0 + ... clear @@ -35,6 +64,7 @@ Clear statistics. .. code-block:: console spp > pri; clear + Clear port statistics. launch -- 2.7.4