netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Steve Wise <swise@opengridcomputing.com>
To: dsahern@gmail.com, leon@kernel.org
Cc: stephen@networkplumber.org, netdev@vger.kernel.org,
	linux-rdma@vger.kernel.org, leon@kernel.org, BMT@zurich.ibm.com
Subject: [PATCH RFC iproute2-next 2/2] rdma: man page update for link add/delete
Date: Wed, 28 Nov 2018 07:16:38 -0800	[thread overview]
Message-ID: <a241e151b862f7d3b590be3df125cb05525e6b72.1543422310.git.swise@opengridcomputing.com> (raw)
In-Reply-To: <cover.1543422310.git.swise@opengridcomputing.com>

Update the 'rdma link' man page with 'link add/delete' info.

Signed-off-by: Steve Wise <swise@opengridcomputing.com>
---
 man/man8/rdma-link.8 | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)

diff --git a/man/man8/rdma-link.8 b/man/man8/rdma-link.8
index 97dd8bb994d2..b994c326dc34 100644
--- a/man/man8/rdma-link.8
+++ b/man/man8/rdma-link.8
@@ -23,6 +23,20 @@ rdma-link \- rdma link configuration
 .RI "[ " DEV/PORT_INDEX " ]"
 
 .ti -8
+.B rdma link add
+.BR NAME
+.BR type
+.BR TYPE
+.BR dev
+.BR NETDEV
+
+.ti -8
+.B rdma link delete
+.RI NAME
+.BR type
+.BR TYPE
+
+.ti -8
 .B rdma link help
 
 .SH "DESCRIPTION"
@@ -33,6 +47,33 @@ rdma-link \- rdma link configuration
 - specifies the RDMA link to show.
 If this argument is omitted all links are listed.
 
+.SS rdma link add NAME type TYPE dev NETDEV - add an rdma link for the specified type to the network device
+.sp
+.BR NAME
+- specifies the new name of the rdma link to add
+
+.BR TYPE
+- specifies which rdma type to use.  Link types:
+.sp
+.in +8
+.B rxe
+- Soft RoCE driver
+.sp
+.B siw
+- Soft iWARP driver
+.in -8
+
+.BR NETDEV
+- specifies the network device to which the link is bound
+
+.SS rdma link delete NAME type TYPE - delete an rdma link for the specified type
+.PP
+.BR NAME
+- specifies the name of the rdma link to delete
+.PP
+.BR TYPE
+- specifies which rdma type to use
+
 .SH "EXAMPLES"
 .PP
 rdma link show
@@ -45,6 +86,16 @@ rdma link show mlx5_2/1
 Shows the state of specified rdma link.
 .RE
 .PP
+rdma link add siw_eth0 type rxe dev eth0
+.RS 4
+Adds a RXE link named siw_eth0 to network device eth0
+.RE
+.PP
+rdma link del siw_eth0 type rxe
+.RS 4
+Removes RXE link siw_eth0
+.RE
+.PP
 
 .SH SEE ALSO
 .BR rdma (8),
-- 
1.8.3.1

      parent reply	other threads:[~2018-11-29  3:29 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-28 16:25 [PATCH RFC iproute2-next 0/2] Dynamic rdma link creation Steve Wise
2018-09-13 17:19 ` [PATCH RFC iproute2-next 1/2] rdma: add 'link add/delete' commands Steve Wise
2018-11-28 18:26   ` Leon Romanovsky
2018-11-28 19:08     ` Steve Wise
2018-11-28 19:34       ` Steve Wise
2018-11-28 20:02         ` Leon Romanovsky
2018-11-28 20:08           ` Leon Romanovsky
2018-11-28 20:23             ` Steve Wise
2018-11-28 20:04       ` Leon Romanovsky
2018-11-28 20:07         ` Steve Wise
2018-11-28 20:13           ` Leon Romanovsky
2018-11-28 20:18             ` Steve Wise
2018-11-28 22:17               ` Jason Gunthorpe
2018-11-28 22:21                 ` Steve Wise
2018-11-28 22:25                   ` Jason Gunthorpe
2018-11-28 22:51                     ` Steve Wise
2018-11-28 15:16 ` Steve Wise [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=a241e151b862f7d3b590be3df125cb05525e6b72.1543422310.git.swise@opengridcomputing.com \
    --to=swise@opengridcomputing.com \
    --cc=BMT@zurich.ibm.com \
    --cc=dsahern@gmail.com \
    --cc=leon@kernel.org \
    --cc=linux-rdma@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=stephen@networkplumber.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).