From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from tama50.ecl.ntt.co.jp (tama50.ecl.ntt.co.jp [129.60.39.147]) by dpdk.org (Postfix) with ESMTP id 167E6559A for ; Mon, 4 Feb 2019 04:15:03 +0100 (CET) Received: from vc2.ecl.ntt.co.jp (vc2.ecl.ntt.co.jp [129.60.86.154]) by tama50.ecl.ntt.co.jp (8.13.8/8.13.8) with ESMTP id x143F3I4030608; Mon, 4 Feb 2019 12:15:03 +0900 Received: from vc2.ecl.ntt.co.jp (localhost [127.0.0.1]) by vc2.ecl.ntt.co.jp (Postfix) with ESMTP id F2EAB638CBE; Mon, 4 Feb 2019 12:15:02 +0900 (JST) Received: from localhost.localdomain (lobster.nslab.ecl.ntt.co.jp [129.60.13.95]) by vc2.ecl.ntt.co.jp (Postfix) with ESMTP id E26A2638B20; Mon, 4 Feb 2019 12:15:02 +0900 (JST) From: ogawa.yasufumi@lab.ntt.co.jp To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp Date: Mon, 4 Feb 2019 12:12:51 +0900 Message-Id: <1549249973-31741-2-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1549249973-31741-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> References: <1549249973-31741-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> X-TM-AS-MML: disable Subject: [spp] [PATCH 1/3] docs: add config 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: Mon, 04 Feb 2019 03:15:04 -0000 From: Yasufumi Ogawa This patch is to add `config` command in "SPP Commands" chapter. Signed-off-by: Yasufumi Ogawa --- docs/guides/commands/common.rst | 73 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) diff --git a/docs/guides/commands/common.rst b/docs/guides/commands/common.rst index ef862c5..6c72878 100644 --- a/docs/guides/commands/common.rst +++ b/docs/guides/commands/common.rst @@ -23,6 +23,79 @@ Show the status of SPP processes. 2: vf:3 +config +------ + +Show or update config params. + +Config params used for changing behaviour of SPP CLI. For instance, if you +change command prompt, you can set any of prompt with ``config`` command +other than default ``spp >``. + +.. code-block:: none + + # set prompt to "$ spp" + spp > config prompt "$ spp" + Set prompt: "$ spp " + $ spp + + +Show Config +~~~~~~~~~~~ + +To show the list of config all of params, simply run ``config``. + +.. code-block:: none + + # show list of config + spp > config + - max_secondary: "16" # The maximum number of secondary processes + - sec_nfv_nof_lcores: "1" # Default num of lcores for workers of spp_nfv + - topo_size: "60%" # Percentage or ratio of topo + - sec_base_lcore: "1" # Shared lcore among secondaryes + .... + +Or show params only started from ``sec_``, add the keyword to the commnad. + +.. code-block:: none + + # show config started from `sec_` + spp > config sec_ + - sec_vhost_cli: "" # Vhost client mode, activated if set any of values + - sec_mem: "-m 512" # Mem size + - sec_nfv_nof_lcores: "1" # Default num of lcores for workers of spp_nfv + - sec_base_lcore: "1" # Shared lcore among secondaryes + .... + +Set Config +~~~~~~~~~~ + +One of typical uses of ``config`` command is to change the default params of +other commands. ``pri; launch`` takes several options for launching secondary +process and it is completed by using default params started from ``sec_``. + +.. code-block:: none + + spp > pri; launch nfv 2 # press TAB for completion + spp > pri; launch nfv 2 -l 1,2 -m 512 -- -n 2 -s 192.168.11.59:6666 + +The default number of memory size is ``-m 512`` and the definition +``sec_mem`` can be changed with ``config`` command. +Here is an example of changing ``-m 512`` to ``--socket-mem 512,0``. + +.. code-block:: none + + spp > config sec_mem "--socket-mem 512,0" + Set sec_mem: "--socket-mem 512,0" + +After updating the param, expanded options is also updated. + +.. code-block:: none + + spp > pri; launch nfv 2 # press TAB for completion + spp > pri; launch nfv 2 -l 1,2 --socket-mem 512,0 -- -n 2 -s ... + + playback -------- -- 2.7.4