* [PATCH iproute2 0/2] rdma man pages improvements
@ 2020-02-28 17:36 Andrea Claudi
2020-02-28 17:36 ` [PATCH iproute2 1/2] man: rdma.8: Add missing resource subcommand description Andrea Claudi
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Andrea Claudi @ 2020-02-28 17:36 UTC (permalink / raw)
To: netdev; +Cc: stephen, dsahern
- 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(-)
--
2.24.1
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH iproute2 1/2] man: rdma.8: Add missing resource subcommand description
2020-02-28 17:36 [PATCH iproute2 0/2] rdma man pages improvements Andrea Claudi
@ 2020-02-28 17:36 ` Andrea Claudi
2020-02-28 17:36 ` [PATCH iproute2 2/2] man: rdma-statistic: Add filter description Andrea Claudi
2020-02-28 21:55 ` [PATCH iproute2 0/2] rdma man pages improvements Stephen Hemminger
2 siblings, 0 replies; 4+ messages in thread
From: Andrea Claudi @ 2020-02-28 17:36 UTC (permalink / raw)
To: netdev; +Cc: stephen, dsahern
Add resource subcommand in the OBJECT section and a short
description for it.
Reported-by: Zhaojuan Guo <zguo@redhat.com>
Signed-off-by: Andrea Claudi <aclaudi@redhat.com>
---
man/man8/rdma.8 | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/man/man8/rdma.8 b/man/man8/rdma.8
index ef29b1c633644..221bf3343bf4c 100644
--- a/man/man8/rdma.8
+++ b/man/man8/rdma.8
@@ -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.
--
2.24.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH iproute2 2/2] man: rdma-statistic: Add filter description
2020-02-28 17:36 [PATCH iproute2 0/2] rdma man pages improvements Andrea Claudi
2020-02-28 17:36 ` [PATCH iproute2 1/2] man: rdma.8: Add missing resource subcommand description Andrea Claudi
@ 2020-02-28 17:36 ` Andrea Claudi
2020-02-28 21:55 ` [PATCH iproute2 0/2] rdma man pages improvements Stephen Hemminger
2 siblings, 0 replies; 4+ messages in thread
From: Andrea Claudi @ 2020-02-28 17:36 UTC (permalink / raw)
To: netdev; +Cc: stephen, dsahern
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 --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);
--
2.24.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH iproute2 0/2] rdma man pages improvements
2020-02-28 17:36 [PATCH iproute2 0/2] rdma man pages improvements Andrea Claudi
2020-02-28 17:36 ` [PATCH iproute2 1/2] man: rdma.8: Add missing resource subcommand description Andrea Claudi
2020-02-28 17:36 ` [PATCH iproute2 2/2] man: rdma-statistic: Add filter description Andrea Claudi
@ 2020-02-28 21:55 ` Stephen Hemminger
2 siblings, 0 replies; 4+ messages in thread
From: Stephen Hemminger @ 2020-02-28 21:55 UTC (permalink / raw)
To: Andrea Claudi; +Cc: netdev, dsahern
On Fri, 28 Feb 2020 18:36:23 +0100
Andrea Claudi <aclaudi@redhat.com> 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
>
> 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
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2020-02-28 21:55 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-02-28 17:36 [PATCH iproute2 0/2] rdma man pages improvements Andrea Claudi
2020-02-28 17:36 ` [PATCH iproute2 1/2] man: rdma.8: Add missing resource subcommand description Andrea Claudi
2020-02-28 17:36 ` [PATCH iproute2 2/2] man: rdma-statistic: Add filter description Andrea Claudi
2020-02-28 21:55 ` [PATCH iproute2 0/2] rdma man pages improvements Stephen Hemminger
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).