diff mbox series

[v10,8/8] doc: add some extended features in procinfo guide

Message ID 20221011111843.3311-9-liudongdong3@huawei.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series app/procinfo: add some extended features |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/github-robot: build success github build: passed
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Dongdong Liu Oct. 11, 2022, 11:18 a.m. UTC 
Add the below extended features in procinfo guide.

--show-port-private
--version
--firmware-version
--show-rss-reta
--show-module-eeprom
--show-rx-descriptor
--show-tx-descriptor

Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
Acked-by: Reshma Pattan <reshma.pattan@intel.com>
---
 doc/guides/tools/proc_info.rst | 36 ++++++++++++++++++++++++++++++++--
 1 file changed, 34 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
index 9772d97ef0..ad70bc47a5 100644
--- a/doc/guides/tools/proc_info.rst
+++ b/doc/guides/tools/proc_info.rst
@@ -17,9 +17,12 @@  The application has a number of command line options:
 
 .. code-block:: console
 
-   ./<build_dir>/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats |
+   ./<build_dir>/app/dpdk-proc-info -- -m | [-p PORTMASK] [--stats | --xstats |
    --stats-reset | --xstats-reset] [ --show-port | --show-tm | --show-crypto |
-   --show-ring[=name] | --show-mempool[=name] | --iter-mempool=name ]
+   --show-ring[=name] | --show-mempool[=name] | --iter-mempool=name |
+   --show-port-private | --version | --firmware-version | --show-rss-reta |
+   --show-module-eeprom | --show-rx-descriptor queue_id:offset:num |
+   --show-tx-descriptor queue_id:offset:num]
 
 Parameters
 ~~~~~~~~~~
@@ -69,6 +72,35 @@  mempool. For invalid or no mempool name, whole list is dump.
 The iter-mempool parameter iterates and displays mempool elements specified
 by name. For invalid or no mempool name no elements are displayed.
 
+**--show-port-private**
+The show-port-private parameter displays ports private information.
+
+**--version**
+The version parameter displays DPDK version.
+
+**--firmware-version**
+The firmware-version parameter displays ethdev firmware version.
+
+**--show-rss-reta**
+The show-rss-reta parameter displays ports rss redirection table.
+
+**--show-module-eeprom**
+The show-module-eeprom parameter displays ports module eeprom information.
+
+**--show-rx-descriptor queue_id:offset:num**
+The show-rx-descriptor parameter displays ports Rx descriptor information
+specified by queue_id, offset and num.
+queue_id: A Rx queue identifier on this port.
+offset: The offset of the descriptor starting from tail.
+num: The number of the descriptors to dump.
+
+**--show-tx-descriptor queue_id:offset:num**
+The show-tx-descriptor parameter displays ports Tx descriptor information
+specified by queue_id, offset and num.
+queue_id: A Tx queue identifier on this port.
+offset: The offset of the descriptor starting from tail.
+num: The number of the descriptors to dump.
+
 Limitations
 -----------