Explanation of flow dump command is added into testpmd functions.
Signed-off-by: Xiaoyu Min <jack...@mellanox.com>
---
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
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
~~~~~~~~~~~~~~~~~~~~~~
--
2.24.1
