New upstream version 17.08

[deb_dpdk.git] / doc / guides / tools / pdump.rst

diff --git a/doc/guides/tools/pdump.rst b/doc/guides/tools/pdump.rst
index 57097e4..16502f7 100644 (file)
--- a/doc/guides/tools/pdump.rst
+++ b/doc/guides/tools/pdump.rst
@@ -28,6 +28,7 @@
     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+.. _pdump_tool:
 
 dpdk-pdump Application
 ======================
@@ -38,6 +39,12 @@ 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.
+        In dpdk, only the ``testpmd`` is modified to initialize packet capture
+        framework, other applications remain untouched. So, if the ``dpdk-pdump``
+        tool has to be used with any application other than the testpmd, user
+        needs to explicitly modify that application to call packet capture
+        framework initialization code. Refer ``app/test-pmd/testpmd.c``
+        code to see how this is done.
 
       * The ``dpdk-pdump`` tool depends on libpcap based PMD which is disabled
         by default in the build configuration files,