[dpdk-dev] doc: update note on packet capture framework initialization

Message ID 1499091478-20984-1-git-send-email-reshma.pattan@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Pattan, Reshma July 3, 2017, 2:17 p.m. UTC
  Updated note to make users aware that the packet capture framework
is initialized by default only in testpmd. Other primary applications
need to explicitly modify the code to do this initialization.

Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>
---
 doc/guides/tools/pdump.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Comments

Thomas Monjalon July 9, 2017, 8:40 p.m. UTC | #1
03/07/2017 16:17, Reshma Pattan:
> Updated note to make users aware that the packet capture framework
> is initialized by default only in testpmd. Other primary applications
> need to explicitly modify the code to do this initialization.
> 
> Signed-off-by: Reshma Pattan <reshma.pattan@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/tools/pdump.rst b/doc/guides/tools/pdump.rst
index 57097e4..b46a92f 100644
--- a/doc/guides/tools/pdump.rst
+++ b/doc/guides/tools/pdump.rst
@@ -38,6 +38,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,