Skip to contentSkip to conversation

rdma man pages improvements

PATCH In review Andrea Claudi 2 participants 4 messages Feb 28, 2020

Subsystems (2)
Networking Network drivers
lore
Share & tools
lore

Andrea Claudi

author
#0 lore raw

cover rdma man pages improvements

- Add missing descriptions for both resource subcomand and filters on the statistic subcommand.
- Add filter description on the rdma statistic help message
- Fix some whitespace issue on the rdma statistic man page

Andrea Claudi (2):
man: rdma.8: Add missing resource subcommand description
man: rdma-statistic: Add filter description

 man/man8/rdma-statistic.8 | 16 ++++++++++++----
 man/man8/rdma.8           |  6 +++++-
 rdma/stat.c               |  1 +
 3 files changed, 18 insertions(+), 5 deletions(-)
Signature · 1 line
2.24.1
author
#1 lore raw

PATCH 1/2 man: rdma.8: Add missing resource subcommand description

Add resource subcommand in the OBJECT section and a short description for it.

Reported-by Zhaojuan Guo <[email protected]>
Signed-off-by Andrea Claudi <[email protected]>
---
 man/man8/rdma.8 | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)
man/man8/rdma.8 +5 -1
index ef29b1c633644..221bf3343bf4c 100644
@@ -19,7 +19,7 @@ rdma \- RDMA tool
 
 .ti -8
 .IR OBJECT " := { "
-.BR dev " | " link " | " system " | " statistic " }"
+.BR dev " | " link " | " resource " | " system " | " statistic " }"
 .sp
 
 .ti -8

@@ -70,6 +70,10 @@ Generate JSON output.
 .B link
 - RDMA port related.
 
+.TP
+.B resource
+- RDMA resource configuration.
+
 .TP
 .B sys
 - RDMA subsystem related.
Signature · 1 line
2.24.1
author
#2 lore raw

PATCH 2/2 man: rdma-statistic: Add filter description

In reply to Andrea Claudi

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 <[email protected]>
Signed-off-by Andrea Claudi <[email protected]>
---
 man/man8/rdma-statistic.8 | 16 ++++++++++++----
 rdma/stat.c               |  1 +
 2 files changed, 13 insertions(+), 4 deletions(-)
man/man8/rdma-statistic.8 +12 -4
index e3f4b51b15524..7de495c919928 100644
@@ -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.
rdma/stat.c +1 -0
index 2f57528700bc4..8d4b7a11681b3 100644
@@ -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);
Signature · 1 line
2.24.1
#3 lore raw
In reply to Andrea Claudi
Quoted 5 lines · On Fri, 28 Feb 2020 18:36:23 +0100 Andrea Claudi <[email protected]> wrote:

- Add missing descriptions for both resource subcomand and filters on the statistic subcommand.
- Add filter description on the rdma statistic help message
- Fix some whitespace issue on the rdma statistic man page

Quoted 9 lines

Andrea Claudi (2):
man: rdma.8: Add missing resource subcommand description
man: rdma-statistic: Add filter description

 man/man8/rdma-statistic.8 | 16 ++++++++++++----
 man/man8/rdma.8           |  6 +++++-
 rdma/stat.c               |  1 +
 3 files changed, 18 insertions(+), 5 deletions(-)

Looks good, applied