[dpdk-dev,1/2] doc: add pcap dependency note to pdump tool guide
Commit Message
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(-)
Comments
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Reshma Pattan
> Sent: Wednesday, July 6, 2016 4:58 PM
> To: dev@dpdk.org
> Cc: Pattan, Reshma <reshma.pattan@intel.com>
> Subject: [dpdk-dev] [PATCH 1/2] doc: add pcap dependency note to pdump
> tool guide
>
> 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>
Acked-by: John McNamara <john.mcnamara@intel.com>
@@ -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