From: ogawa.yasufumi@lab.ntt.co.jp
To: spp@dpdk.org, ferruh.yigit@intel.com, ogawa.yasufumi@lab.ntt.co.jp
Subject: [spp] [PATCH 1/3] docs: add config command
Date: Mon, 4 Feb 2019 12:12:51 +0900 [thread overview]
Message-ID: <1549249973-31741-2-git-send-email-ogawa.yasufumi@lab.ntt.co.jp> (raw)
In-Reply-To: <1549249973-31741-1-git-send-email-ogawa.yasufumi@lab.ntt.co.jp>
From: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
This patch is to add `config` command in "SPP Commands" chapter.
Signed-off-by: Yasufumi Ogawa <ogawa.yasufumi@lab.ntt.co.jp>
---
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
next prev parent reply other threads:[~2019-02-04 3:15 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-04 3:12 [spp] [PATCH 0/3] Update documentation for pri launch command ogawa.yasufumi
2019-02-04 3:12 ` ogawa.yasufumi [this message]
2019-02-04 3:12 ` [spp] [PATCH 2/3] docs: add usage of " ogawa.yasufumi
2019-02-04 3:12 ` [spp] [PATCH 3/3] docs: update how to use guide ogawa.yasufumi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1549249973-31741-2-git-send-email-ogawa.yasufumi@lab.ntt.co.jp \
--to=ogawa.yasufumi@lab.ntt.co.jp \
--cc=ferruh.yigit@intel.com \
--cc=spp@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).