app/procinfo: add --show-ring

[dpdk.git] / doc / guides / tools / proc_info.rst

diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
index 883864d..ba5c3db 100644 (file)
--- a/doc/guides/tools/proc_info.rst
+++ b/doc/guides/tools/proc_info.rst
@@ -18,7 +18,8 @@ The application has a number of command line options:
 .. code-block:: console
 
    ./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats |
-   --stats-reset | --xstats-reset] [ --show-port | --show-tm | --show-crypto ]
+   --stats-reset | --xstats-reset] [ --show-port | --show-tm | --show-crypto |
+   --show-ring[=name] ]
 
 Parameters
 ~~~~~~~~~~
@@ -54,6 +55,11 @@ configurations and statistics.
 The show-crypto parameter displays available cryptodev configurations,
 settings and stats per node.
 
+**--show-ring[=name]**
+The show-ring pararmeter display current allocation of all ring with
+debug information. Specifying the name allows to display details for specific
+ring. For invalid or no ring name, whole list is dump.
+
 Limitations
 -----------