diff mbox series

doc: update testpmd guide for flow dump command

Message ID cc93be7ecaa919c686e16594cae94ddf2dfef39d.1579492347.git.jackmin@mellanox.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers show
Series doc: update testpmd guide for flow dump command | expand

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed
ci/checkpatch success coding style OK

Commit Message

Xiaoyu Min Jan. 20, 2020, 4:01 a.m. UTC
Explanation of flow dump command is added into testpmd functions.

Signed-off-by: Xiaoyu Min <jackmin@mellanox.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

Comments

Ferruh Yigit Jan. 20, 2020, 3:45 p.m. UTC | #1
On 1/20/2020 4:01 AM, Xiaoyu Min wrote:
> Explanation of flow dump command is added into testpmd functions.
> 
> Signed-off-by: Xiaoyu Min <jackmin@mellanox.com>

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied to dpdk-next-net/master, thanks.
diff mbox series

Patch

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index fbb3c5a3b3..5103ff9259 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -3604,6 +3604,10 @@  following sections.
 
    flow isolate {port_id} {boolean}
 
+- Dump internal representation information of all flows in hardware::
+
+   flow dump {port_id} {output_file}
+
 Validating flow rules
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -4466,6 +4470,22 @@  Disabling isolated mode::
  Ingress traffic on port 0 is not restricted anymore to the defined flow rules
  testpmd>
 
+Dumping HW internal information
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``flow dump`` dumps the hardware's internal representation information of
+all flows. It is bound to ``rte_flow_dev_dump()``::
+
+   flow dump {port_id} {output_file}
+
+If successful, it will show::
+
+   Flow dump finished
+
+Otherwise, it will complain error occurred::
+
+   Caught error type [...] ([...]): [...]
+
 Sample QinQ flow rules
 ~~~~~~~~~~~~~~~~~~~~~~