diff mbox

[dpdk-dev] doc: add note on primary process dependency

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

Commit Message

Pattan, Reshma Oct. 13, 2016, 3:09 p.m. UTC
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 | 2 ++
 1 file changed, 2 insertions(+)

Comments

Thomas Monjalon Oct. 26, 2016, 7:58 p.m. UTC | #1
2016-10-13 16:09, Reshma Pattan:
> 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>

Applied, thanks
diff mbox

Patch

diff --git a/doc/guides/sample_app_ug/pdump.rst b/doc/guides/sample_app_ug/pdump.rst
index ac0e7c9..4098e50 100644
--- a/doc/guides/sample_app_ug/pdump.rst
+++ b/doc/guides/sample_app_ug/pdump.rst
@@ -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,