doc: add pdump limitation note
authorReshma Pattan <reshma.pattan@intel.com>
Thu, 13 Oct 2016 15:09:02 +0000 (16:09 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Wed, 26 Oct 2016 19:58:43 +0000 (21:58 +0200)
The note i.e. "The dpdk-pdump tool can only be used in
conjunction with a primary process which has the packet
capture framework initialized already" is added to
doc/guides/sample_app_ug/pdump.rst to facilitate
easy understanding on the usage of the tool.

Suggested-by: Jianfeng Tan <jianfeng.tan@intel.com>
Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
doc/guides/sample_app_ug/pdump.rst

index 320c914..099e7dc 100644 (file)
@@ -37,6 +37,8 @@ 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 can only be used in conjunction with a primary
+        application which has the packet capture framework initialized already.
 
       * The ``dpdk-pdump`` tool depends on libpcap based PMD which is disabled
         by default in the build configuration files,