Soft Patch Panel
 help / color / mirror / Atom feed
From: yasufum.o@gmail.com
To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com
Subject: [spp] [PATCH 5/6] docs: add desc for env command
Date: Fri, 20 Dec 2019 16:41:02 +0900	[thread overview]
Message-ID: <20191220074103.14065-6-yasufum.o@gmail.com> (raw)
In-Reply-To: <20191220074103.14065-1-yasufum.o@gmail.com>

From: Yasufumi Ogawa <yasufum.o@gmail.com>

This update is to add description for env command in `Common Commands`
section.

Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>
---
 docs/guides/commands/common.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docs/guides/commands/common.rst b/docs/guides/commands/common.rst
index cfa4eaf..d3b8262 100644
--- a/docs/guides/commands/common.rst
+++ b/docs/guides/commands/common.rst
@@ -230,6 +230,23 @@ You cannot unregister node under the control, or switch to other one before.
     Cannot del server "1" in use!
 
 
+.. _commands_common_env:
+
+env
+---
+
+Show environmental variables. It is mainly used to find variables related to
+SPP.
+
+.. code-block:: console
+
+    # show all env varibles.
+    spp > env
+
+    # show env varibles starts with `SPP`.
+    spp > env SPP
+
+
 .. _commands_common_pwd:
 
 pwd
-- 
2.17.1


  parent reply	other threads:[~2019-12-20  7:41 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-12-20  7:40 [spp] [PATCH 0/6] Run SPP with --file-prefix option yasufum.o
2019-12-20  7:40 ` [spp] [PATCH 1/6] cli: add env command yasufum.o
2019-12-20  7:40 ` [spp] [PATCH 2/6] cli: add file prefix opt for launch cmd yasufum.o
2019-12-20  7:41 ` [spp] [PATCH 3/6] bin: add SPP_FILE_PREFIX env variable yasufum.o
2019-12-20  7:41 ` [spp] [PATCH 4/6] readme: update example of config.sh yasufum.o
2019-12-20  7:41 ` yasufum.o [this message]
2019-12-20  7:41 ` [spp] [PATCH 6/6] docs: add file prefix option in usecases yasufum.o

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=20191220074103.14065-6-yasufum.o@gmail.com \
    --to=yasufum.o@gmail.com \
    --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).