summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYasufumi Ogawa <yasufum.o@gmail.com>2019-08-22 17:26:50 +0900
committerYasufumi Ogawa <yasufum.o@gmail.com>2019-08-26 10:44:03 +0700
commitbfa70b26ea0e5725fd6644cda546eff73f4df8e2 (patch)
tree94b3a3a08231e5393723cb2aee2b04bf9ef3a3c6
parent7d50b184b04e0ad96414274a82bfedf9c126f9a8 (diff)
downloadspp-bfa70b26ea0e5725fd6644cda546eff73f4df8e2.zip
spp-bfa70b26ea0e5725fd6644cda546eff73f4df8e2.tar.gz
spp-bfa70b26ea0e5725fd6644cda546eff73f4df8e2.tar.xz
docs: add captured port types for spp_pcap
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>
-rw-r--r--docs/guides/design/spp_secondary.rst6
-rw-r--r--docs/guides/gsg/howto_use.rst2
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``.