diff mbox series

[iproute2,2/2] man: rdma-statistic: Add filter description

Message ID 47dbeb5ef715c89c941d0449e29d20da5f4612dc.1582910855.git.aclaudi@redhat.com
State Accepted
Delegated to: stephen hemminger
Headers show
Series rdma man pages improvements | expand

Commit Message

Andrea Claudi Feb. 28, 2020, 5:36 p.m. UTC 
Add description for filters on rdma statistics show command.
Also add a filter description on the help message of the command.
Additionally, fix some whitespace issue in the man page.

Reported-by: Zhaojuan Guo <zguo@redhat.com>
Signed-off-by: Andrea Claudi <aclaudi@redhat.com>
---
 man/man8/rdma-statistic.8 | 16 ++++++++++++----
 rdma/stat.c               |  1 +
 2 files changed, 13 insertions(+), 4 deletions(-)
diff mbox series

Patch

diff --git a/man/man8/rdma-statistic.8 b/man/man8/rdma-statistic.8
index e3f4b51b15524..7de495c919928 100644
--- a/man/man8/rdma-statistic.8
+++ b/man/man8/rdma-statistic.8
@@ -9,7 +9,7 @@  rdma-statistic \- RDMA statistic counter configuration
 .B rdma
 .RI "[ " OPTIONS " ]"
 .B statistic
-.RI  " { " COMMAND " | "
+.RI  "{ " COMMAND " | "
 .BR help " }"
 .sp
 
@@ -23,6 +23,7 @@  rdma-statistic \- RDMA statistic counter configuration
 .RI "[ " OBJECT " ]"
 .B show link
 .RI "[ " DEV/PORT_INDX " ]"
+.RI "[ " FILTER_NAME " " FILTER_VALUE " ]"
 
 .ti -8
 .B rdma statistic
@@ -34,7 +35,7 @@  rdma-statistic \- RDMA statistic counter configuration
 .IR OBJECT
 .B set
 .IR COUNTER_SCOPE
-.RI "[ " DEV/PORT_INDEX "]"
+.RI "[ " DEV/PORT_INDEX " ]"
 .B auto
 .RI "{ " CRITERIA " | "
 .BR off " }"
@@ -44,7 +45,7 @@  rdma-statistic \- RDMA statistic counter configuration
 .IR OBJECT
 .B bind
 .IR COUNTER_SCOPE
-.RI "[ " DEV/PORT_INDEX "]"
+.RI "[ " DEV/PORT_INDEX " ]"
 .RI "[ " OBJECT-ID " ]"
 .RI "[ " COUNTER-ID " ]"
 
@@ -53,7 +54,7 @@  rdma-statistic \- RDMA statistic counter configuration
 .IR OBJECT
 .B unbind
 .IR COUNTER_SCOPE
-.RI "[ " DEV/PORT_INDEX "]"
+.RI "[ " DEV/PORT_INDEX " ]"
 .RI "[ " COUNTER-ID " ]"
 .RI "[ " OBJECT-ID " ]"
 
@@ -69,6 +70,10 @@  rdma-statistic \- RDMA statistic counter configuration
 .IR CRITERIA " := "
 .RB "{ " type " }"
 
+.ti -8
+.IR FILTER_NAME " := "
+.RB "{ " cntn " | " lqpn " | " pid " }"
+
 .SH "DESCRIPTION"
 .SS rdma statistic [object] show - Queries the specified RDMA device for RDMA and driver-specific statistics. Show the default hw counters if object is not specified
 
@@ -79,6 +84,9 @@  rdma-statistic \- RDMA statistic counter configuration
 .I "PORT_INDEX"
 - specifies counters on this RDMA port to show.
 
+.I "FILTER_NAME
+- specifies a filter to show only the results matching it.
+
 .SS rdma statistic <object> set - configure counter statistic auto-mode for a specific device/port
 In auto mode all objects belong to one category are bind automatically to a single counter set. Not applicable for MR's.
 
diff --git a/rdma/stat.c b/rdma/stat.c
index 2f57528700bc4..8d4b7a11681b3 100644
--- a/rdma/stat.c
+++ b/rdma/stat.c
@@ -23,6 +23,7 @@  static int stat_help(struct rd *rd)
 	pr_out("where  OBJECT: = { qp }\n");
 	pr_out("       CRITERIA : = { type }\n");
 	pr_out("       COUNTER_SCOPE: = { link | dev }\n");
+	pr_out("       FILTER_NAME: = { cntn | lqpn | pid }\n");
 	pr_out("Examples:\n");
 	pr_out("       %s statistic qp show\n", rd->filename);
 	pr_out("       %s statistic qp show link mlx5_2/1\n", rd->filename);