From: Andrea Claudi <aclaudi@redhat.com>
Date: Fri, 28 Feb 2020 17:36:25 +0000 (+0100)
Subject: man: rdma-statistic: Add filter description
X-Git-Tag: v5.6.0~6
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=31824e2299bf5dc609026436db629b0c25cc1a10;p=thirdparty%2Fiproute2.git

man: rdma-statistic: Add filter description

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>
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---

diff --git a/man/man8/rdma-statistic.8 b/man/man8/rdma-statistic.8
index e3f4b51b1..7de495c91 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 2f5752870..8d4b7a116 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);