Soft Patch Panel
 help / color / Atom feed
From: Itsuro Oda <oda@valinux.co.jp>
To: spp@dpdk.org, ferruh.yigit@intel.com, yasufum.o@gmail.com
Subject: [spp] [PATCH 1/3] docs: add CLI for pipe PMD
Date: Mon, 13 Apr 2020 08:00:55 +0900
Message-ID: <20200412230057.28631-2-oda@valinux.co.jp> (raw)
In-Reply-To: <20200412230057.28631-1-oda@valinux.co.jp>

This patch adds description about CLI for pipe PMD.

Signed-off-by: Itsuro Oda <oda@valinux.co.jp>
---
 docs/guides/commands/primary.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/guides/commands/primary.rst b/docs/guides/commands/primary.rst
index cb510a6..7c55166 100644
--- a/docs/guides/commands/primary.rst
+++ b/docs/guides/commands/primary.rst
@@ -51,6 +51,8 @@ Show status fo ``spp_primary`` and forwarding statistics of each of ports.
     spp > pri; status
     - lcore_ids:
       - master: 0
+    - pipes:
+      - pipe:0 ring:0 ring:1
     - stats
       - physical ports:
           ID          rx          tx    tx_drop   rxq  txq mac_addr
@@ -78,6 +80,7 @@ also displayed.
       - ports:
         - phy:0
         - phy:1
+    - pipes:
     - stats
       - physical ports:
           ID          rx          tx    tx_drop  mac_addr
@@ -110,6 +113,7 @@ add
 
 Add a port with resource ID.
 
+If the type of a port is other than pipe, specify port only.
 For example, adding ``ring:0`` by
 
 .. code-block:: console
@@ -124,6 +128,18 @@ Or adding ``vhost:0`` by
     spp > pri; add vhost:0
     Add vhost:0.
 
+If the type of a port is pipe, specify a ring for rx and a ring
+for tx following a port. For example,
+
+.. code-block:: console
+
+    spp > pri; add pipe:0 ring:0 ring:1
+    Add pipe:0.
+
+.. note::
+
+   pipe is independent of the forwarder and can be added even if the
+   forwarder does not exist.
 
 .. _commands_primary_patch:
 
-- 
2.17.0


  reply index

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-12 23:00 [spp] [PATCH 0/3] add document of " Itsuro Oda
2020-04-12 23:00 ` Itsuro Oda [this message]
2020-04-12 23:00 ` [spp] [PATCH 2/3] docs: add REST API for " Itsuro Oda
2020-04-12 23:00 ` [spp] [PATCH 3/3] docs: add document of pipe PMD usecase Itsuro Oda
2020-04-30  2:38 ` [spp] (x-fn-spp-ml 671) [PATCH 0/3] add document of pipe PMD Hideyuki Yamashita
2020-05-25  3:07 ` [spp] " Yasufumi Ogawa

Reply instructions:

You may reply publically 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=20200412230057.28631-2-oda@valinux.co.jp \
    --to=oda@valinux.co.jp \
    --cc=ferruh.yigit@intel.com \
    --cc=spp@dpdk.org \
    --cc=yasufum.o@gmail.com \
    /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

Soft Patch Panel

Archives are clonable:
	git clone --mirror http://inbox.dpdk.org/spp/0 spp/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 spp spp/ http://inbox.dpdk.org/spp \
		spp@dpdk.org
	public-inbox-index spp


Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.spp


AGPL code for this site: git clone https://public-inbox.org/ public-inbox