From: Reshma Pattan <reshma.pattan@intel.com>
To: dev@dpdk.org
Cc: Reshma Pattan <reshma.pattan@intel.com>
Subject: [dpdk-dev] [PATCH 1/2] doc: add pcap dependency note to pdump tool guide
Date: Wed, 6 Jul 2016 16:57:39 +0100 [thread overview]
Message-ID: <1467820660-3418-2-git-send-email-reshma.pattan@intel.com> (raw)
In-Reply-To: <1467820660-3418-1-git-send-email-reshma.pattan@intel.com>
Added a missing note about dependencies on libpcap and
CONFIG_RTE_LIBRTE_PMD_PCAP flag that pdump tool has.
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
---
doc/guides/sample_app_ug/pdump.rst | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/doc/guides/sample_app_ug/pdump.rst b/doc/guides/sample_app_ug/pdump.rst
index 96c8709..32d4fbc 100644
--- a/doc/guides/sample_app_ug/pdump.rst
+++ b/doc/guides/sample_app_ug/pdump.rst
@@ -33,14 +33,21 @@
dpdk_pdump Application
======================
-The ``dpdk_pdump`` application is a Data Plane Development Kit (DPDK) application that runs as a DPDK secondary process and
+The ``dpdk_pdump`` tool is a Data Plane Development Kit (DPDK) tool that runs as a DPDK secondary process and
is capable of enabling packet capture on dpdk ports.
+ .. Note::
+
+ * The ``dpdk_pdump`` tool depends on libpcap based PMD which is disabled by default in the build configuration
+ files, owing to an external dependency on the libpcap development files which must be installed on the board.
+ Once the libpcap development files are installed, the libpcap based PMD can be enabled by setting
+ CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK.
+
Running the Application
-----------------------
-The application has a ``--pdump`` command line option with various sub arguments:
+The tool has a ``--pdump`` command line option with various sub arguments:
.. code-block:: console
--
2.5.0
next prev parent reply other threads:[~2016-07-06 15:57 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-06 15:57 [dpdk-dev] [PATCH 0/2] update packet capture framework doc Reshma Pattan
2016-07-06 15:57 ` Reshma Pattan [this message]
2016-07-06 16:52 ` [dpdk-dev] [PATCH 1/2] doc: add pcap dependency note to pdump tool guide Mcnamara, John
2016-07-06 15:57 ` [dpdk-dev] [PATCH 2/2] doc: add pdump shared library version to release notes Reshma Pattan
2016-07-06 16:52 ` Mcnamara, John
2016-07-16 9:32 ` [dpdk-dev] [PATCH 0/2] update packet capture framework doc Thomas Monjalon
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=1467820660-3418-2-git-send-email-reshma.pattan@intel.com \
--to=reshma.pattan@intel.com \
--cc=dev@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).