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 v2] docs: add captured port types for spp_pcap
Date: Thu, 22 Aug 2019 17:26:50 +0900	[thread overview]
Message-ID: <20190822082650.20263-1-yasufum.o@gmail.com> (raw)
In-Reply-To: <20190821080531.14050-1-yasufum.o@gmail.com>

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

Spp_pcap only supports two port types, phy and ring, currently. However,
There is no explanation for the supported types. This update is to add
descriptions for.

Signed-off-by: Yasufumi Ogawa <yasufum.o@gmail.com>
---
 docs/guides/design/spp_secondary.rst | 6 +++---
 docs/guides/gsg/howto_use.rst        | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/guides/design/spp_secondary.rst b/docs/guides/design/spp_secondary.rst
index b89d8b4..c24928c 100644
--- a/docs/guides/design/spp_secondary.rst
+++ b/docs/guides/design/spp_secondary.rst
@@ -209,10 +209,10 @@ specific port. It is aimed to capture up to 10Gbps packets.
 ``spp_pcap`` in which ``spp_pcap`` process receives packets from ``phy:0``
 for capturing.
 
-``spp_pcap`` provides packet capturing capability as a SPP secondary process.
-``spp_pcap`` has one manager thread like spp_vf, and has two types of worker
-threads unlike spp_vf.
+.. note::
 
+   ``spp_pcap`` supports only two types of ports for capturing, ``phy``
+   and ``ring``, currently.
 
 .. _figure_spp_pcap_overview:
 
diff --git a/docs/guides/gsg/howto_use.rst b/docs/guides/gsg/howto_use.rst
index dee0a84..5e461eb 100644
--- a/docs/guides/gsg/howto_use.rst
+++ b/docs/guides/gsg/howto_use.rst
@@ -540,7 +540,7 @@ options of ``spp_pcap``.
 
 * ``--client-id``: Client ID unique among secondary processes.
 * ``-s``: IPv4 address and secondary port of spp-ctl.
-* ``-c``: Captured port, e.g. ``phy:0``, ``ring:1`` or so.
+* ``-c``: Captured port. Only ``phy`` and ``ring`` are supported.
 * ``--out-dir``: Optional. Path of dir for captured file. Default is ``/tmp``.
 * ``--fsize``: Optional. Maximum size of a capture file. Default is ``1GiB``.
 
-- 
2.17.1


      reply	other threads:[~2019-08-22  8:26 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-21  8:05 [spp] [PATCH] " yasufum.o
2019-08-22  8:26 ` yasufum.o [this message]

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=20190822082650.20263-1-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).