]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
doc: Update nvme-connect by describing options
authorMinwoo Im <minwoo.im.dev@gmail.com>
Wed, 3 Apr 2019 16:25:47 +0000 (01:25 +0900)
committerMinwoo Im <minwoo.im.dev@gmail.com>
Wed, 3 Apr 2019 16:25:47 +0000 (01:25 +0900)
Few newly added options have not been described.  This patch updates
document of nvme-connect.

It also makes "See Also" part style proper which have been applied
properly as a title.

Signed-off-by: Minwoo Im <minwoo.im.dev@gmail.com>
Documentation/nvme-connect.1
Documentation/nvme-connect.html
Documentation/nvme-connect.txt

index 7cb03f47422f3d3fa6146b180ed599cfd5924eb3..c607e52836faee1834a20c69c54694df74f0ab2a 100644 (file)
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: nvme-connect
 .\"    Author: [see the "AUTHORS" section]
-.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\"      Date: 01/08/2019
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 04/04/2019
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-CONNECT" "1" "01/08/2019" "NVMe" "NVMe Manual"
+.TH "NVME\-CONNECT" "1" "04/04/2019" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -39,6 +39,7 @@ nvme-connect \- Connect to a Fabrics controller\&.
                 [\-\-trsvcid=<trsvcid>      | \-s <trsvcid>]
                 [\-\-host\-traddr=<traddr>   | \-w <traddr>]
                 [\-\-hostnqn=<hostnqn>      | \-q <hostnqn>]
+                [\-\-hostid=<hostid>        | \-I <hostid>]
                 [\-\-nr\-io\-queues=<#>       | \-i <#>]
                 [\-\-nr\-write\-queues=<#>    | \-W <#>]
                 [\-\-nr\-poll\-queues=<#>     | \-P <#>]
@@ -46,6 +47,10 @@ nvme-connect \- Connect to a Fabrics controller\&.
                 [\-\-keep\-alive\-tmo=<#>     | \-k <#>]
                 [\-\-reconnect\-delay=<#>    | \-c <#>]
                 [\-\-ctrl\-loss\-tmo=<#>      | \-l <#>]
+                [\-\-duplicate_connect      | \-D]
+                [\-\-disable_sqflow         | \-d]
+                [\-\-hdr_digest             | \-g]
+                [\-\-data_digest            | \-G]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -111,6 +116,11 @@ This field specifies the network address used on the host to connect to the Cont
 Overrides the default Host NQN that identifies the NVMe Host\&. If this option is not specified, the default is read from /etc/nvme/hostnqn first\&. If that does not exist, the autogenerated NQN value from the NVMe Host kernel module is used next\&. The Host NQN uniquely identifies the NVMe Host\&.
 .RE
 .PP
+\-I <hostid>, \-\-hostid=<hostid>
+.RS 4
+UUID(Universally Unique Identifier) to be discovered which should be formatted\&.
+.RE
+.PP
 \-i <#>, \-\-nr\-io\-queues=<#>
 .RS 4
 Overrides the default number of I/O queues create by the driver\&.
@@ -145,6 +155,26 @@ Overrides the default delay (in seconds) before reconnect is attempted after a c
 .RS 4
 Overrides the default controller loss timeout period (in seconds)\&.
 .RE
+.PP
+\-D, \-\-duplicate_connect
+.RS 4
+Allows duplicated connections between same trnsport host and subsystem port\&.
+.RE
+.PP
+\-d, \-\-disable_sqflow
+.RS 4
+Disables SQ flow control to omit head doorbell update for submission queues when sending nvme completions\&.
+.RE
+.PP
+\-g, \-\-hdr_digest
+.RS 4
+Generates/verifies header digest (TCP)\&.
+.RE
+.PP
+\-G, \-\-data_digest
+.RS 4
+Generates/verifies data digest (TCP)\&.
+.RE
 .SH "EXAMPLES"
 .sp
 .RS 4
@@ -168,16 +198,7 @@ Connect to a subsystem named nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\
 .RE
 .\}
 .RE
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-SEE ALSO
-.fi
-.if n \{\
-.RE
-.\}
+.SH "SEE ALSO"
 .sp
 nvme\-discover(1) nvme\-connect\-all(1)
 .SH "AUTHORS"
index 5ac9361bb6ab14a1ed402f116ba3249ff866f905..8e3c6c05f1d85aa20e8583a57f11606b4470086a 100644 (file)
@@ -1,9 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
 <head>\r
 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.10" />\r
 <title>nvme-connect(1)</title>\r
 <style type="text/css">\r
 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
@@ -94,7 +95,9 @@ ul > li > * { color: black; }
   padding: 0;\r
   margin: 0;\r
 }\r
-\r
+pre {\r
+  white-space: pre-wrap;\r
+}\r
 \r
 #author {\r
   color: #527bbd;\r
@@ -223,7 +226,7 @@ div.exampleblock > div.content {
 }\r
 \r
 div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
 a.image:visited { color: white; }\r
 \r
 dl {\r
@@ -753,13 +756,18 @@ nvme-connect(1) Manual Page
                 [--trsvcid=&lt;trsvcid&gt;      | -s &lt;trsvcid&gt;]\r
                 [--host-traddr=&lt;traddr&gt;   | -w &lt;traddr&gt;]\r
                 [--hostnqn=&lt;hostnqn&gt;      | -q &lt;hostnqn&gt;]\r
+                [--hostid=&lt;hostid&gt;        | -I &lt;hostid&gt;]\r
                 [--nr-io-queues=&lt;#&gt;       | -i &lt;#&gt;]\r
                 [--nr-write-queues=&lt;#&gt;    | -W &lt;#&gt;]\r
                 [--nr-poll-queues=&lt;#&gt;     | -P &lt;#&gt;]\r
                 [--queue-size=&lt;#&gt;         | -Q &lt;#&gt;]\r
                 [--keep-alive-tmo=&lt;#&gt;     | -k &lt;#&gt;]\r
                 [--reconnect-delay=&lt;#&gt;    | -c &lt;#&gt;]\r
-                [--ctrl-loss-tmo=&lt;#&gt;      | -l &lt;#&gt;]</pre>\r
+                [--ctrl-loss-tmo=&lt;#&gt;      | -l &lt;#&gt;]\r
+                [--duplicate_connect      | -D]\r
+                [--disable_sqflow         | -d]\r
+                [--hdr_digest             | -g]\r
+                [--data_digest            | -G]</pre>\r
 <div class="attribution">\r
 </div></div>\r
 </div>\r
@@ -880,6 +888,18 @@ cellspacing="0" cellpadding="4">
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+-I &lt;hostid&gt;\r
+</dt>\r
+<dt class="hdlist1">\r
+--hostid=&lt;hostid&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        UUID(Universally Unique Identifier) to be discovered which should be\r
+        formatted.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 -i &lt;#&gt;\r
 </dt>\r
 <dt class="hdlist1">\r
@@ -958,6 +978,52 @@ cellspacing="0" cellpadding="4">
         Overrides the default controller loss timeout period (in seconds).\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+-D\r
+</dt>\r
+<dt class="hdlist1">\r
+--duplicate_connect\r
+</dt>\r
+<dd>\r
+<p>\r
+        Allows duplicated connections between same trnsport host and subsystem\r
+        port.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-d\r
+</dt>\r
+<dt class="hdlist1">\r
+--disable_sqflow\r
+</dt>\r
+<dd>\r
+<p>\r
+        Disables SQ flow control to omit head doorbell update for submission\r
+        queues when sending nvme completions.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-g\r
+</dt>\r
+<dt class="hdlist1">\r
+--hdr_digest\r
+</dt>\r
+<dd>\r
+<p>\r
+        Generates/verifies header digest (TCP).\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-G\r
+</dt>\r
+<dt class="hdlist1">\r
+--data_digest\r
+</dt>\r
+<dd>\r
+<p>\r
+        Generates/verifies data digest (TCP).\r
+</p>\r
+</dd>\r
 </dl></div>\r
 </div>\r
 </div>\r
@@ -977,10 +1043,11 @@ on the IP4 address 192.168.1.3. Port 4420 is used by default:
 </div></div>\r
 </li>\r
 </ul></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><code>SEE ALSO</code></pre>\r
-</div></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_see_also">SEE ALSO</h2>\r
+<div class="sectionbody">\r
 <div class="paragraph"><p>nvme-discover(1)\r
 nvme-connect-all(1)</p></div>\r
 </div>\r
@@ -1003,7 +1070,8 @@ 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 2019-01-02 08:45:04 MST\r
+Last updated\r
+ 2019-04-04 01:15:21 KST\r
 </div>\r
 </div>\r
 </body>\r
index 5412472dbd35895c012a2318b0acd1b6c1066276..45cb110f05a3ebf90ad8c60b1513ed66e1517ee6 100644 (file)
@@ -15,6 +15,7 @@ SYNOPSIS
                [--trsvcid=<trsvcid>      | -s <trsvcid>]
                [--host-traddr=<traddr>   | -w <traddr>]
                [--hostnqn=<hostnqn>      | -q <hostnqn>]
+               [--hostid=<hostid>        | -I <hostid>]
                [--nr-io-queues=<#>       | -i <#>]
                [--nr-write-queues=<#>    | -W <#>]
                [--nr-poll-queues=<#>     | -P <#>]
@@ -22,6 +23,10 @@ SYNOPSIS
                [--keep-alive-tmo=<#>     | -k <#>]
                [--reconnect-delay=<#>    | -c <#>]
                [--ctrl-loss-tmo=<#>      | -l <#>]
+               [--duplicate_connect      | -D]
+               [--disable_sqflow         | -d]
+               [--hdr_digest             | -g]
+               [--data_digest            | -G]
 
 DESCRIPTION
 -----------
@@ -73,6 +78,11 @@ OPTIONS
        NQN value from the NVMe Host kernel module is used next.
        The Host NQN uniquely identifies the NVMe Host.
 
+-I <hostid>::
+--hostid=<hostid>::
+       UUID(Universally Unique Identifier) to be discovered which should be
+       formatted.
+
 -i <#>::
 --nr-io-queues=<#>::
        Overrides the default number of I/O queues create by the driver.
@@ -103,6 +113,24 @@ OPTIONS
 --ctrl-loss-tmo=<#>::
        Overrides the default controller loss timeout period (in seconds).
 
+-D::
+--duplicate_connect::
+       Allows duplicated connections between same trnsport host and subsystem
+       port.
+
+-d::
+--disable_sqflow::
+       Disables SQ flow control to omit head doorbell update for submission
+       queues when sending nvme completions.
+
+-g::
+--hdr_digest::
+       Generates/verifies header digest (TCP).
+
+-G::
+--data_digest::
+       Generates/verifies data digest (TCP).
+
 EXAMPLES
 --------
 * Connect to a subsystem named nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
@@ -113,8 +141,6 @@ on the IP4 address 192.168.1.3. Port 4420 is used by default:
 --nqn=nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
 ------------
 
-------------
-
 SEE ALSO
 --------
 nvme-discover(1)