naccyde / rpms / iproute

Forked from rpms/iproute 9 months ago
Clone

Blame SOURCES/0068-rdma-add-man-pages-for-RDMA-tool.patch

36cfb7
From 4bee4617fa17405a52e11ed47e21feb20a277cc2 Mon Sep 17 00:00:00 2001
36cfb7
From: Andrea Claudi <aclaudi@redhat.com>
36cfb7
Date: Thu, 28 Mar 2019 15:00:33 +0100
36cfb7
Subject: [PATCH] rdma: add man pages for RDMA tool
36cfb7
36cfb7
Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=1642479
36cfb7
Upstream Status: RHEL-only
36cfb7
36cfb7
commit 379afb6274462dee196d5909f6988b1ce5466c0b
36cfb7
Author: Andrea Claudi <aclaudi@redhat.com>
36cfb7
Date:   Thu Mar 28 13:02:20 2019 +0100
36cfb7
36cfb7
    rdma: add man pages for RDMA tool
36cfb7
36cfb7
    Checkout to the v5.0.0 upstream tag and update man8 Makefile
36cfb7
36cfb7
    Signed-off-by: Andrea Claudi <aclaudi@redhat.com>
36cfb7
---
36cfb7
 man/man8/Makefile        |   2 +-
36cfb7
 man/man8/rdma-dev.8      |  69 +++++++++++++++++++++++
36cfb7
 man/man8/rdma-link.8     |  56 ++++++++++++++++++
36cfb7
 man/man8/rdma-resource.8 | 109 +++++++++++++++++++++++++++++++++++
36cfb7
 man/man8/rdma.8          | 119 +++++++++++++++++++++++++++++++++++++++
36cfb7
 5 files changed, 354 insertions(+), 1 deletion(-)
36cfb7
 create mode 100644 man/man8/rdma-dev.8
36cfb7
 create mode 100644 man/man8/rdma-link.8
36cfb7
 create mode 100644 man/man8/rdma-resource.8
36cfb7
 create mode 100644 man/man8/rdma.8
36cfb7
36cfb7
diff --git a/man/man8/Makefile b/man/man8/Makefile
36cfb7
index f33186446819e..416443f3f5361 100644
36cfb7
--- a/man/man8/Makefile
36cfb7
+++ b/man/man8/Makefile
36cfb7
@@ -19,7 +19,7 @@ MAN8PAGES = $(TARGETS) ip.8 arpd.8 lnstat.8 routel.8 rtacct.8 rtmon.8 rtpr.8 ss.
36cfb7
 	tc-simple.8 tc-skbedit.8 tc-vlan.8 tc-xt.8 tc-skbmod.8 tc-ife.8 \
36cfb7
 	tc-tunnel_key.8 tc-sample.8 \
36cfb7
 	devlink.8 devlink-dev.8 devlink-monitor.8 devlink-port.8 devlink-sb.8 \
36cfb7
-	ifstat.8
36cfb7
+	ifstat.8 rdma.8 rdma-dev.8 rdma-link.8 rdma-resource.8
36cfb7
 
36cfb7
 all: $(TARGETS)
36cfb7
 
36cfb7
diff --git a/man/man8/rdma-dev.8 b/man/man8/rdma-dev.8
36cfb7
new file mode 100644
36cfb7
index 0000000000000..069f471791904
36cfb7
--- /dev/null
36cfb7
+++ b/man/man8/rdma-dev.8
36cfb7
@@ -0,0 +1,69 @@
36cfb7
+.TH RDMA\-DEV 8 "06 Jul 2017" "iproute2" "Linux"
36cfb7
+.SH NAME
36cfb7
+rdma-dev \- RDMA device configuration
36cfb7
+.SH SYNOPSIS
36cfb7
+.sp
36cfb7
+.ad l
36cfb7
+.in +8
36cfb7
+.ti -8
36cfb7
+.B rdma
36cfb7
+.RI "[ " OPTIONS " ]"
36cfb7
+.B dev
36cfb7
+.RI  " { " COMMAND " | "
36cfb7
+.BR help " }"
36cfb7
+.sp
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.IR OPTIONS " := { "
36cfb7
+\fB\-V\fR[\fIersion\fR] |
36cfb7
+\fB\-d\fR[\fIetails\fR] }
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.B rdma dev show
36cfb7
+.RI "[ " DEV " ]"
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.B rdma dev set
36cfb7
+.RI "[ " DEV " ]"
36cfb7
+.BR name
36cfb7
+.BR NEWNAME
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.B rdma dev help
36cfb7
+
36cfb7
+.SH "DESCRIPTION"
36cfb7
+.SS rdma dev set - rename rdma device
36cfb7
+
36cfb7
+.SS rdma dev show - display rdma device attributes
36cfb7
+
36cfb7
+.PP
36cfb7
+.I "DEV"
36cfb7
+- specifies the RDMA device to show.
36cfb7
+If this argument is omitted all devices are listed.
36cfb7
+
36cfb7
+.SH "EXAMPLES"
36cfb7
+.PP
36cfb7
+rdma dev
36cfb7
+.RS 4
36cfb7
+Shows the state of all RDMA devices on the system.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma dev show mlx5_3
36cfb7
+.RS 4
36cfb7
+Shows the state of specified RDMA device.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma dev set mlx5_3 name rdma_0
36cfb7
+.RS 4
36cfb7
+Renames the mlx5_3 device to rdma_0.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+
36cfb7
+.SH SEE ALSO
36cfb7
+.BR rdma (8),
36cfb7
+.BR rdma-link (8),
36cfb7
+.BR rdma-resource (8),
36cfb7
+.br
36cfb7
+
36cfb7
+.SH AUTHOR
36cfb7
+Leon Romanovsky <leonro@mellanox.com>
36cfb7
diff --git a/man/man8/rdma-link.8 b/man/man8/rdma-link.8
36cfb7
new file mode 100644
36cfb7
index 0000000000000..bddf34746e8b2
36cfb7
--- /dev/null
36cfb7
+++ b/man/man8/rdma-link.8
36cfb7
@@ -0,0 +1,56 @@
36cfb7
+.TH RDMA\-LINK 8 "06 Jul 2017" "iproute2" "Linux"
36cfb7
+.SH NAME
36cfb7
+rdma-link \- rdma link configuration
36cfb7
+.SH SYNOPSIS
36cfb7
+.sp
36cfb7
+.ad l
36cfb7
+.in +8
36cfb7
+.ti -8
36cfb7
+.B devlink
36cfb7
+.RI "[ " OPTIONS " ]"
36cfb7
+.B link
36cfb7
+.RI  " { " COMMAND " | "
36cfb7
+.BR help " }"
36cfb7
+.sp
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.IR OPTIONS " := { "
36cfb7
+\fB\-V\fR[\fIersion\fR] |
36cfb7
+\fB\-d\fR[\fIetails\fR] }
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.B rdma link show
36cfb7
+.RI "[ " DEV/PORT_INDEX " ]"
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.B rdma link help
36cfb7
+
36cfb7
+.SH "DESCRIPTION"
36cfb7
+.SS rdma link show - display rdma link attributes
36cfb7
+
36cfb7
+.PP
36cfb7
+.I "DEV/PORT_INDEX"
36cfb7
+- specifies the RDMA link to show.
36cfb7
+If this argument is omitted all links are listed.
36cfb7
+
36cfb7
+.SH "EXAMPLES"
36cfb7
+.PP
36cfb7
+rdma link show
36cfb7
+.RS 4
36cfb7
+Shows the state of all rdma links on the system.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma link show mlx5_2/1
36cfb7
+.RS 4
36cfb7
+Shows the state of specified rdma link.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+
36cfb7
+.SH SEE ALSO
36cfb7
+.BR rdma (8),
36cfb7
+.BR rdma-dev (8),
36cfb7
+.BR rdma-resource (8),
36cfb7
+.br
36cfb7
+
36cfb7
+.SH AUTHOR
36cfb7
+Leon Romanovsky <leonro@mellanox.com>
36cfb7
diff --git a/man/man8/rdma-resource.8 b/man/man8/rdma-resource.8
36cfb7
new file mode 100644
36cfb7
index 0000000000000..40b073dbfcf24
36cfb7
--- /dev/null
36cfb7
+++ b/man/man8/rdma-resource.8
36cfb7
@@ -0,0 +1,109 @@
36cfb7
+.TH RDMA\-RESOURCE 8 "26 Dec 2017" "iproute2" "Linux"
36cfb7
+.SH NAME
36cfb7
+rdma-resource \- rdma resource configuration
36cfb7
+.SH SYNOPSIS
36cfb7
+.sp
36cfb7
+.ad l
36cfb7
+.in +8
36cfb7
+.ti -8
36cfb7
+.B rdma
36cfb7
+.RI "[ " OPTIONS " ] " RESOURCE " { " COMMAND " | "
36cfb7
+.BR help " }"
36cfb7
+.sp
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.IR RESOURCE " := { "
36cfb7
+.BR cm_id " | " cq " | " mr " | " pd " | " qp " }"
36cfb7
+.sp
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.IR OPTIONS " := { "
36cfb7
+\fB\-j\fR[\fIson\fR] |
36cfb7
+\fB\-d\fR[\fIetails\fR] }
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.B rdma resource show
36cfb7
+.RI "[ " DEV/PORT_INDEX " ]"
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.B rdma resource help
36cfb7
+
36cfb7
+.SH "DESCRIPTION"
36cfb7
+.SS rdma resource show - display rdma resource tracking information
36cfb7
+
36cfb7
+.PP
36cfb7
+.I "DEV/PORT_INDEX"
36cfb7
+- specifies the RDMA link to show.
36cfb7
+If this argument is omitted all links are listed.
36cfb7
+
36cfb7
+.SH "EXAMPLES"
36cfb7
+.PP
36cfb7
+rdma resource show
36cfb7
+.RS 4
36cfb7
+Shows summary for all devices on the system.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma resource show mlx5_2
36cfb7
+.RS 4
36cfb7
+Shows the state of specified rdma device.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma res show qp link mlx5_4
36cfb7
+.RS 4
36cfb7
+Get all QPs for the specific device.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma res show qp link mlx5_4/1
36cfb7
+.RS 4
36cfb7
+Get QPs of specific port.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma res show qp link mlx5_4/0
36cfb7
+.RS 4
36cfb7
+Provide illegal port number (0 is illegal).
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma res show qp link mlx5_4/-
36cfb7
+.RS 4
36cfb7
+Get QPs which have not assigned port yet.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma res show qp link mlx5_4/- -d
36cfb7
+.RS 4
36cfb7
+Detailed view.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma res show qp link mlx5_4/- -dd
36cfb7
+.RS 4
36cfb7
+Detailed view including driver-specific details.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma res show qp link mlx5_4/1 lqpn 0-6
36cfb7
+.RS 4
36cfb7
+Limit to specific Local QPNs.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma resource show cm_id dst-port 7174
36cfb7
+.RS 4
36cfb7
+Show CM_IDs with destination ip port of 7174.
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma resource show cm_id src-addr 172.16.0.100
36cfb7
+.RS 4
36cfb7
+Show CM_IDs bound to local ip address 172.16.0.100
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+rdma resource show cq pid 30489
36cfb7
+.RS 4
36cfb7
+Show CQs belonging to pid 30489
36cfb7
+.RE
36cfb7
+.PP
36cfb7
+
36cfb7
+.SH SEE ALSO
36cfb7
+.BR rdma (8),
36cfb7
+.BR rdma-dev (8),
36cfb7
+.BR rdma-link (8),
36cfb7
+.br
36cfb7
+
36cfb7
+.SH AUTHOR
36cfb7
+Leon Romanovsky <leonro@mellanox.com>
36cfb7
diff --git a/man/man8/rdma.8 b/man/man8/rdma.8
36cfb7
new file mode 100644
36cfb7
index 0000000000000..b2b5aef866ab0
36cfb7
--- /dev/null
36cfb7
+++ b/man/man8/rdma.8
36cfb7
@@ -0,0 +1,119 @@
36cfb7
+.TH RDMA 8 "28 Mar 2017" "iproute2" "Linux"
36cfb7
+.SH NAME
36cfb7
+rdma \- RDMA tool
36cfb7
+.SH SYNOPSIS
36cfb7
+.sp
36cfb7
+.ad l
36cfb7
+.in +8
36cfb7
+.ti -8
36cfb7
+.B rdma
36cfb7
+.RI "[ " OPTIONS " ] " OBJECT " { " COMMAND " | "
36cfb7
+.BR help " }"
36cfb7
+.sp
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.B rdma
36cfb7
+.RB "[ " -force " ] "
36cfb7
+.BI "-batch " filename
36cfb7
+.sp
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.IR OBJECT " := { "
36cfb7
+.BR dev " | " link " }"
36cfb7
+.sp
36cfb7
+
36cfb7
+.ti -8
36cfb7
+.IR OPTIONS " := { "
36cfb7
+\fB\-V\fR[\fIersion\fR] |
36cfb7
+\fB\-d\fR[\fIetails\fR] }
36cfb7
+\fB\-j\fR[\fIson\fR] }
36cfb7
+\fB\-p\fR[\fIretty\fR] }
36cfb7
+
36cfb7
+.SH OPTIONS
36cfb7
+
36cfb7
+.TP
36cfb7
+.BR "\-V" , " -Version"
36cfb7
+Print the version of the
36cfb7
+.B rdma
36cfb7
+tool and exit.
36cfb7
+
36cfb7
+.TP
36cfb7
+.BR "\-b", " \-batch " <FILENAME>
36cfb7
+Read commands from provided file or standard input and invoke them.
36cfb7
+First failure will cause termination of rdma.
36cfb7
+
36cfb7
+.TP
36cfb7
+.BR "\-force"
36cfb7
+Don't terminate rdma on errors in batch mode.
36cfb7
+If there were any errors during execution of the commands, the application return code will be non zero.
36cfb7
+
36cfb7
+.TP
36cfb7
+.BR "\-d" , " --details"
36cfb7
+Output detailed information.  Adding a second \-d includes driver-specific details.
36cfb7
+
36cfb7
+.TP
36cfb7
+.BR "\-p" , " --pretty"
36cfb7
+When combined with -j generate a pretty JSON output.
36cfb7
+
36cfb7
+.TP
36cfb7
+.BR "\-j" , " --json"
36cfb7
+Generate JSON output.
36cfb7
+
36cfb7
+.SS
36cfb7
+.I OBJECT
36cfb7
+
36cfb7
+.TP
36cfb7
+.B dev
36cfb7
+- RDMA device.
36cfb7
+
36cfb7
+.TP
36cfb7
+.B link
36cfb7
+- RDMA port related.
36cfb7
+
36cfb7
+.PP
36cfb7
+The names of all objects may be written in full or
36cfb7
+abbreviated form, for example
36cfb7
+.B stats
36cfb7
+can be abbreviated as
36cfb7
+.B stat
36cfb7
+or just
36cfb7
+.B s.
36cfb7
+
36cfb7
+.SS
36cfb7
+.I COMMAND
36cfb7
+
36cfb7
+Specifies the action to perform on the object.
36cfb7
+The set of possible actions depends on the object type.
36cfb7
+As a rule, it is possible to
36cfb7
+.B show
36cfb7
+(or
36cfb7
+.B list
36cfb7
+) objects, but some objects do not allow all of these operations
36cfb7
+or have some additional commands. The
36cfb7
+.B help
36cfb7
+command is available for all objects. It prints
36cfb7
+out a list of available commands and argument syntax conventions.
36cfb7
+.sp
36cfb7
+If no command is given, some default command is assumed.
36cfb7
+Usually it is
36cfb7
+.B list
36cfb7
+or, if the objects of this class cannot be listed,
36cfb7
+.BR "help" .
36cfb7
+
36cfb7
+.SH EXIT STATUS
36cfb7
+Exit status is 0 if command was successful or a positive integer upon failure.
36cfb7
+
36cfb7
+.SH SEE ALSO
36cfb7
+.BR rdma-dev (8),
36cfb7
+.BR rdma-link (8),
36cfb7
+.BR rdma-resource (8),
36cfb7
+.br
36cfb7
+
36cfb7
+.SH REPORTING BUGS
36cfb7
+Report any bugs to the Linux RDMA mailing list
36cfb7
+.B <linux-rdma@vger.kernel.org>
36cfb7
+where the development and maintenance is primarily done.
36cfb7
+You do not have to be subscribed to the list to send a message there.
36cfb7
+
36cfb7
+.SH AUTHOR
36cfb7
+Leon Romanovsky <leonro@mellanox.com>
36cfb7
-- 
36cfb7
2.20.1
36cfb7