Imported Upstream version 16.11
[deb_dpdk.git] / doc / guides / tools / pdump.rst
similarity index 94%
rename from doc/guides/sample_app_ug/pdump.rst
rename to doc/guides/tools/pdump.rst
index ac0e7c9..57097e4 100644 (file)
@@ -1,4 +1,3 @@
-
 ..  BSD LICENSE
     Copyright(c) 2016 Intel Corporation. All rights reserved.
     All rights reserved.
@@ -37,6 +36,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,
@@ -119,8 +120,8 @@ Can be either a pcap file name or any Linux iface.
       * To receive ingress and egress packets separately ``rx-dev`` and ``tx-dev``
         should both be passed with the different file names or the Linux iface names.
 
-      * To receive ingress and egress packets separately ``rx-dev`` and ``tx-dev``
-        should both be passed with the same file names or the the Linux iface names.
+      * To receive ingress and egress packets together, ``rx-dev`` and ``tx-dev``
+        should both be passed with the same file name or the same Linux iface name.
 
 ``ring-size``:
 Size of the ring. This value is used internally for ring creation. The ring will be used to enqueue the packets from