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 <keith.busch@intel.com>

diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1
index 71c9556eaf4d77e92e4912dfa37342ddc457af18..79a42139993b7876600f11ef6278918b94074eba 100644 (file)
--- 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 <http://docbook.sf.net/>
-.\"      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=<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>]
@@ -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 <traddr>, \-\-host\-traddr=<traddr>
+.RS 4
+This field specificies the host traddr\&. Eg\&.: FC WWN\(cqs\&.
+.RE
+.PP
 \-s <trsvcid>, \-\-trsvcid=<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 b2beb1e13b79a26e5e654cab7d475fda05bb0f5f..b20ce04751406984ce67e670722cad631ad13310 100644 (file)
--- a/Documentation/nvme-connect-all.html
+++ b/Documentation/nvme-connect-all.html
@@ -749,6 +749,7 @@ nvme-connect-all(1) Manual Page
 <pre class="content"><em>nvme connect-all</em>\r
                 [--transport=&lt;trtype&gt; | -t &lt;trtype&gt;]\r
                 [--traddr=&lt;traddr&gt;    | -a &lt;traddr&gt;]\r
+                [--host-traddr=&lt;traddr&gt;| -w &lt;host-traddr&gt;]\r
                 [--trsvcid=&lt;trsvcid&gt;  | -s &lt;trsvcid&gt;]\r
                 [--hostnqn=&lt;hostnqn&gt;  | -q &lt;hostnqn&gt;]\r
                 [--raw=&lt;filename&gt;     | -r &lt;filename&gt;]</pre>\r
@@ -829,6 +830,17 @@ cellspacing="0" cellpadding="4">
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+-w &lt;traddr&gt;\r
+</dt>\r
+<dt class="hdlist1">\r
+--host-traddr=&lt;traddr&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        This field specificies the host traddr. Eg.: FC WWN&#8217;s.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 -s &lt;trsvcid&gt;\r
 </dt>\r
 <dt class="hdlist1">\r
@@ -914,7 +926,7 @@ nvme-connect(1)</p></div>
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2016-10-21 12:02:51 EDT\r
+Last updated 2016-10-27 11:59:50 EDT\r
 </div>\r
 </div>\r
 </body>\r

diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt
index 1dc17826105ea5166b5fb77c65853a3e607539c7..40d0913ba5a00f3454b3f669c3b4fd6d3154d5a0 100644 (file)
--- a/Documentation/nvme-connect-all.txt
+++ b/Documentation/nvme-connect-all.txt
@@ -11,6 +11,7 @@ SYNOPSIS
 '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>]
@@ -53,6 +54,10 @@ OPTIONS
        For transports using IP addressing (e.g. rdma) this should be an
        IP-based address (ex. IPv4).
 
+-w <traddr>::
+--host-traddr=<traddr>::
+       This field specificies the host traddr. Eg.: FC WWN's.
+
 -s <trsvcid>::
 --trsvcid=<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 c5ffad2bb9182a3e7cb58155af4bd0ed9545ca2d..c05e66ff319865822fd2fd4461d4cce5e3661df0 100644 (file)
--- 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 <http://docbook.sf.net/>
-.\"      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=<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>]
@@ -60,6 +61,11 @@ TBD
 TBD
 .RE
 .PP
+\-w <traddr>, \-\-host\-traddr=<traddr>
+.RS 4
+TBD
+.RE
+.PP
 \-s <trsvcid>, \-\-trsvcid=<trsvcid>
 .RS 4
 TBD

diff --git a/Documentation/nvme-connect.html b/Documentation/nvme-connect.html
index 2b8ca327f2f8e7630382084fdba589cbf676590c..a041234421e976ac738cc3bfcba06de4d1bdd62d 100644 (file)
--- a/Documentation/nvme-connect.html
+++ b/Documentation/nvme-connect.html
@@ -749,6 +749,7 @@ nvme-connect(1) Manual Page
 <pre class="content"><em>nvme connect</em>  [device]\r
                 [--transport=&lt;trtype&gt;  | -t &lt;trtype&gt;]\r
                 [--traddr=&lt;traddr&gt;     | -a &lt;traddr&gt;]\r
+                [--host-traddr=&lt;traddr&gt;| -w &lt;host-traddr&gt;]\r
                 [--trsvcid=&lt;trsvcid&gt;   | -s &lt;trsvcid&gt;]\r
                 [--hostnqn=&lt;hostnqn&gt;   | -q &lt;hostnqn&gt;]\r
                 [--nqn=&lt;subnqn&gt;        | -n &lt;subnqn&gt;]\r
@@ -798,6 +799,17 @@ nvme-connect(1) Manual Page
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+-w &lt;traddr&gt;\r
+</dt>\r
+<dt class="hdlist1">\r
+--host-traddr=&lt;traddr&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        TBD\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 -s &lt;trsvcid&gt;\r
 </dt>\r
 <dt class="hdlist1">\r
@@ -906,7 +918,7 @@ for <a href="mailto:keith.busch@intel.com">Keith Busch</a>.</p></div>
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2016-10-12 15:10:33 EDT\r
+Last updated 2016-10-27 11:59:03 EDT\r
 </div>\r
 </div>\r
 </body>\r

diff --git a/Documentation/nvme-connect.txt b/Documentation/nvme-connect.txt
index 9ba969e56fa3637d84f3ee45bc14d01bbb67fc3c..affcedf07b1674b3fde3a5f2f8b15c44e786330d 100644 (file)
--- 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=<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>]
@@ -36,6 +37,10 @@ OPTIONS
 --traddr=<traddr>::
        TBD
 
+-w <traddr>::
+--host-traddr=<traddr>::
+       TBD
+
 -s <trsvcid>::
 --trsvcid=<trsvcid>::
        TBD

diff --git a/fabrics.c b/fabrics.c
index eb021a5307e63b46f1d5234ac30ad481372e94ef..affd5393bf4f3f8458c271061a720733d00087b3 100644 (file)
--- 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" },