From: Keith Busch Date: Thu, 27 Oct 2016 16:00:00 +0000 (-0400) Subject: Host-traddr documentation updates X-Git-Tag: v1.0~8 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=0e502e2be395d8c8cd1b281f0de75fd087a285ec;p=users%2Fsagi%2Fnvme-cli.git Host-traddr documentation updates Changed the parameter to use '-' instead of '_' to match consistency of other options. Added the option to the connect and connect all manpages. Replaced the 's' option to 'w' (wwn) as 's' was already in use. Signed-off-by: Keith Busch --- diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1 index 71c9556e..79a42139 100644 --- a/Documentation/nvme-connect-all.1 +++ b/Documentation/nvme-connect-all.1 @@ -2,12 +2,12 @@ .\" Title: nvme-connect-all .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 10/21/2016 +.\" Date: 10/27/2016 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT\-ALL" "1" "10/21/2016" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT\-ALL" "1" "10/27/2016" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -35,6 +35,7 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&. \fInvme connect\-all\fR [\-\-transport= | \-t ] [\-\-traddr= | \-a ] + [\-\-host\-traddr=| \-w ] [\-\-trsvcid= | \-s ] [\-\-hostnqn= | \-q ] [\-\-raw= | \-r ] @@ -89,6 +90,11 @@ T} This field specifies the network address of the Discovery Controller\&. For transports using IP addressing (e\&.g\&. rdma) this should be an IP\-based address (ex\&. IPv4)\&. .RE .PP +\-w , \-\-host\-traddr= +.RS 4 +This field specificies the host traddr\&. Eg\&.: FC WWN\(cqs\&. +.RE +.PP \-s , \-\-trsvcid= .RS 4 This field specifies the transport service id\&. For transports using IP addressing (e\&.g\&. rdma) this field is the port number\&. By default, the IP port number for the RDMA transport is 4420\&. diff --git a/Documentation/nvme-connect-all.html b/Documentation/nvme-connect-all.html index b2beb1e1..b20ce047 100644 --- a/Documentation/nvme-connect-all.html +++ b/Documentation/nvme-connect-all.html @@ -749,6 +749,7 @@ nvme-connect-all(1) Manual Page 
nvme connect-all
                 [--transport=<trtype> | -t <trtype>]
                 [--traddr=<traddr>    | -a <traddr>]
+                [--host-traddr=<traddr>| -w <host-traddr>]
                 [--trsvcid=<trsvcid>  | -s <trsvcid>]
                 [--hostnqn=<hostnqn>  | -q <hostnqn>]
                 [--raw=<filename>     | -r <filename>]
@@ -829,6 +830,17 @@ cellspacing="0" cellpadding="4">

+-w <traddr> +
+
+--host-traddr=<traddr> +
+
+

+ This field specificies the host traddr. Eg.: FC WWN’s. +

+
+
-s <trsvcid>
@@ -914,7 +926,7 @@ nvme-connect(1)

diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt index 1dc17826..40d0913b 100644 --- a/Documentation/nvme-connect-all.txt +++ b/Documentation/nvme-connect-all.txt @@ -11,6 +11,7 @@ SYNOPSIS 'nvme connect-all' [--transport= | -t ] [--traddr= | -a ] + [--host-traddr=| -w ] [--trsvcid= | -s ] [--hostnqn= | -q ] [--raw= | -r ] @@ -53,6 +54,10 @@ OPTIONS For transports using IP addressing (e.g. rdma) this should be an IP-based address (ex. IPv4). +-w :: +--host-traddr=:: + This field specificies the host traddr. Eg.: FC WWN's. + -s :: --trsvcid=:: This field specifies the transport service id. For transports using IP diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1 index c5ffad2b..c05e66ff 100644 --- a/Documentation/nvme-connect.1 +++ b/Documentation/nvme-connect.1 @@ -2,12 +2,12 @@ .\" Title: nvme-connect .\" Author: [see the "AUTHORS" section] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 10/21/2016 +.\" Date: 10/27/2016 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-CONNECT" "1" "10/21/2016" "NVMe" "NVMe Manual" +.TH "NVME\-CONNECT" "1" "10/27/2016" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -35,6 +35,7 @@ nvme-connect \- Connect to an NVMe\-over\-Fabrics subsystem\&. \fInvme connect\fR [device] [\-\-transport= | \-t ] [\-\-traddr= | \-a ] + [\-\-host\-traddr=| \-w ] [\-\-trsvcid= | \-s ] [\-\-hostnqn= | \-q ] [\-\-nqn= | \-n ] @@ -60,6 +61,11 @@ TBD TBD .RE .PP +\-w , \-\-host\-traddr= +.RS 4 +TBD +.RE +.PP \-s , \-\-trsvcid= .RS 4 TBD diff --git a/Documentation/nvme-connect.html b/Documentation/nvme-connect.html index 2b8ca327..a0412344 100644 --- a/Documentation/nvme-connect.html +++ b/Documentation/nvme-connect.html @@ -749,6 +749,7 @@ nvme-connect(1) Manual Page 
nvme connect  [device]
                 [--transport=<trtype>  | -t <trtype>]
                 [--traddr=<traddr>     | -a <traddr>]
+                [--host-traddr=<traddr>| -w <host-traddr>]
                 [--trsvcid=<trsvcid>   | -s <trsvcid>]
                 [--hostnqn=<hostnqn>   | -q <hostnqn>]
                 [--nqn=<subnqn>        | -n <subnqn>]
@@ -798,6 +799,17 @@ nvme-connect(1) Manual Page
 

 
 

+-w <traddr>
+

+

+--host-traddr=<traddr>
+

+

+

+        TBD
+

+

+

 -s <trsvcid>
 

 

@@ -906,7 +918,7 @@ for Keith Busch.

 

 
 
diff --git a/Documentation/nvme-connect.txt b/Documentation/nvme-connect.txt
index 9ba969e5..affcedf0 100644
--- a/Documentation/nvme-connect.txt
+++ b/Documentation/nvme-connect.txt
@@ -1,5 +1,5 @@
 nvme-connect(1)
-==============
+===============
 
 NAME
 ----
@@ -11,6 +11,7 @@ SYNOPSIS
 'nvme connect'	[device]
 		[--transport=  | -t ]
 		[--traddr=     | -a ]
+		[--host-traddr=| -w ]
 		[--trsvcid=   | -s ]
 		[--hostnqn=   | -q ]
 		[--nqn=        | -n ]
@@ -36,6 +37,10 @@ OPTIONS
 --traddr=::
 	TBD
 
+-w ::
+--host-traddr=::
+	TBD
+
 -s ::
 --trsvcid=::
 	TBD
diff --git a/fabrics.c b/fabrics.c
index eb021a53..affd5393 100644
--- a/fabrics.c
+++ b/fabrics.c
@@ -787,7 +787,7 @@ int connect(const char *desc, int argc, char **argv)
 		 required_argument, "transport address" },
 		{"trsvcid", 's', "LIST", CFG_STRING, &cfg.trsvcid,
 		 required_argument, "transport service id (e.g. IP port)" },
-                {"host_traddr", 's', "LIST", CFG_STRING, &cfg.host_traddr,
+                {"host-traddr", 'w', "LIST", CFG_STRING, &cfg.host_traddr,
                  required_argument, "host traddr (e.g. FC WWN's)" },
 		{"hostnqn", 'q', "LIST", CFG_STRING, &cfg.hostnqn,
 		 required_argument, "user-defined hostnqn" },