diff mbox

[ovs-dev,1/1] doc: Update DPDK pdump documentation

Message ID 1475749533-13862-1-git-send-email-mark.b.kavanagh@intel.com
State Accepted
Delegated to: Daniele Di Proietto
Headers show

Commit Message

Mark Kavanagh Oct. 6, 2016, 10:25 a.m. UTC
The DPDK pdump sample app was renamed from 'dpdk_pdump' to
'dpdk-pdump'. Update references to same within
INSTALL.DPDK-ADVANCED.md.

Add an additional sample command line that shows how to capture all
traffic traversing an interface within a single pcap file - a useful
tool for debugging DPDK-related issues.

Signed-off-by: Mark Kavanagh <mark.b.kavanagh@intel.com>
---
 INSTALL.DPDK-ADVANCED.md | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

Comments

Daniele Di Proietto Oct. 14, 2016, 1:05 a.m. UTC | #1
2016-10-06 3:25 GMT-07:00 Mark Kavanagh <mark.b.kavanagh@intel.com>:

> The DPDK pdump sample app was renamed from 'dpdk_pdump' to
> 'dpdk-pdump'. Update references to same within
> INSTALL.DPDK-ADVANCED.md.
>
> Add an additional sample command line that shows how to capture all
> traffic traversing an interface within a single pcap file - a useful
> tool for debugging DPDK-related issues.
>
> Signed-off-by: Mark Kavanagh <mark.b.kavanagh@intel.com>
>

Thanks, applied to master and branch-2.6
diff mbox

Patch

diff --git a/INSTALL.DPDK-ADVANCED.md b/INSTALL.DPDK-ADVANCED.md
index 555f026..f6f0b5b 100644
--- a/INSTALL.DPDK-ADVANCED.md
+++ b/INSTALL.DPDK-ADVANCED.md
@@ -791,16 +791,24 @@  To use pdump, simply launch OVS as usual. Then, navigate to the 'app/pdump'
 directory in DPDK, 'make' the application and run like so:
 
 ```
-sudo ./build/app/dpdk_pdump --
+sudo ./build/app/dpdk-pdump --
 --pdump port=0,queue=0,rx-dev=/tmp/pkts.pcap
 --server-socket-path=/usr/local/var/run/openvswitch
 ```
 
 The above command captures traffic received on queue 0 of port 0 and stores
 it in /tmp/pkts.pcap. Other combinations of port numbers, queues numbers and
-pcap locations are of course also available to use. 'server-socket-path' must
-be set to the value of ovs_rundir() which typically resolves to
-'/usr/local/var/run/openvswitch'.
+pcap locations are of course also available to use. For example, to capture
+all packets that traverse port 0 in a single pcap file:
+
+```
+sudo ./build/app/dpdk-pdump --
+--pdump 'port=0,queue=*,rx-dev=/tmp/pkts.pcap,tx-dev=/tmp/pkts.pcap'
+--server-socket-path=/usr/local/var/run/openvswitch
+```
+
+'server-socket-path' must be set to the value of ovs_rundir() which typically
+resolves to '/usr/local/var/run/openvswitch'.
 More information on the pdump app and its usage can be found in the below link.
 
 http://dpdk.org/doc/guides/sample_app_ug/pdump.html