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 at 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