Regen documentation

Update manpages with latest doc updates.

Signed-off-by: Keith Busch <keith.busch@intel.com>

diff --git a/Documentation/nvme-list-subsys.1 b/Documentation/nvme-list-subsys.1
index 34be6dd8bc8922e6f3503b8f91b07e1171eb52af..f521d0c9e66cdb5f0d909323e61f7bff2809263b 100644 (file)
--- a/Documentation/nvme-list-subsys.1
+++ b/Documentation/nvme-list-subsys.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-list-subsys
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\"      Date: 09/05/2018
+.\"      Date: 11/16/2018
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-LIST\-SUBSYS" "1" "09/05/2018" "NVMe" "NVMe Manual"
+.TH "NVME\-LIST\-SUBSYS" "1" "11/16/2018" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -32,11 +32,11 @@ nvme-list-subsys \- List all NVMe subsystems
 .SH "SYNOPSIS"
 .sp
 .nf
-\fInvme list\-subsys\fR [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme list\-subsys\fR [\-o <fmt> | \-\-output\-format=<fmt>] <device>
 .fi
 .SH "DESCRIPTION"
 .sp
-Scan the sysfs tree for NVM Express subsystems and return the controllers for those subsystems as well as some pertinent information about them\&.
+Scan the sysfs tree for NVM Express subsystems and return the controllers for those subsystems as well as some pertinent information about them\&. If a device is given, print out only the values for the controllers and subsystems leading to the device\&.
 .SH "OPTIONS"
 .PP
 \-o <format>, \-\-output\-format=<format>
@@ -48,9 +48,73 @@ or
 .RE
 .SH "EXAMPLES"
 .sp
-\m[blue]\fBroot@host\fR\m[]\&\s-2\u[1]\d\s+2# nvme list\-subsys nvme\-subsys0 \- NQN=nvmf\-test \e +\- nvme0 rdma traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.1 +\- nvme1 rdma traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.2 nvme\-subsys1 \- NQN=nvmf\-test2 \e +\- nvme2 rdma traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.2 +\- nvme3 rdma traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.1
+.if n \{\
+.RS 4
+.\}
+.nf
+\m[blue]\fBroot@host\fR\m[]\&\s-2\u[1]\d\s+2# nvme list\-subsys
+nvme\-subsys0 \- NQN=nvmf\-test
+\e
+ +\- nvme0 rdma traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.1
+ +\- nvme1 rdma traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.2
+nvme\-subsys1 \- NQN=nvmf\-test2
+\e
+ +\- nvme2 rdma traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.2
+ +\- nvme3 rdma traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.1
+.fi
+.if n \{\
+.RE
+.\}
 .sp
-\m[blue]\fBroot@host\fR\m[]\&\s-2\u[1]\d\s+2# nvme list\-subsys \-o json { "Subsystems" : [ { "Name" : "nvme\-subsys0", "NQN" : "nvmf\-test" }, { "Paths" : [ { "Name" : "nvme0", "Transport" : "rdma", "Address" : "traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.1" }, { "Name" : "nvme1", "Transport" : "rdma", "Address" : "traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.2" } ] }, { "Name" : "nvme\-subsys1", "NQN" : "nvmf\-test2" }, { "Paths" : [ { "Name" : "nvme2", "Transport" : "rdma", "Address" : "traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.2" }, { "Name" : "nvme3", "Transport" : "rdma", "Address" : "traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.1" } ] } ] }
+.if n \{\
+.RS 4
+.\}
+.nf
+\m[blue]\fBroot@host\fR\m[]\&\s-2\u[1]\d\s+2# nvme list\-subsys \-o json
+{
+  "Subsystems" : [
+    {
+      "Name" : "nvme\-subsys0",
+      "NQN" : "nvmf\-test"
+    },
+    {
+      "Paths" : [
+        {
+          "Name" : "nvme0",
+          "Transport" : "rdma",
+          "Address" : "traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.1"
+        },
+        {
+          "Name" : "nvme1",
+          "Transport" : "rdma",
+          "Address" : "traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.2"
+        }
+      ]
+    },
+    {
+      "Name" : "nvme\-subsys1",
+      "NQN" : "nvmf\-test2"
+    },
+    {
+      "Paths" : [
+        {
+          "Name" : "nvme2",
+          "Transport" : "rdma",
+          "Address" : "traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.2"
+        },
+        {
+          "Name" : "nvme3",
+          "Transport" : "rdma",
+          "Address" : "traddr=1\&.1\&.1\&.3 trsvcid=4420 host_traddr=1\&.1\&.1\&.1"
+        }
+      ]
+    }
+  ]
+}
+.fi
+.if n \{\
+.RE
+.\}
 .SH "NVME"
 .sp
 Part of the nvme\-user suite

diff --git a/Documentation/nvme-list-subsys.html b/Documentation/nvme-list-subsys.html
index 0754f6ccaea5685b6edbf1348bcef59145ccf39b..f3a1e9bf57f28bbe335c33870b036f76d27f2a8e 100644 (file)
--- a/Documentation/nvme-list-subsys.html
+++ b/Documentation/nvme-list-subsys.html
@@ -746,7 +746,7 @@ nvme-list-subsys(1) Manual Page
 <h2 id="_synopsis">SYNOPSIS</h2>\r
 <div class="sectionbody">\r
 <div class="verseblock">\r
-<pre class="content"><em>nvme list-subsys</em> [-o &lt;fmt&gt; | --output-format=&lt;fmt&gt;]</pre>\r
+<pre class="content"><em>nvme list-subsys</em> [-o &lt;fmt&gt; | --output-format=&lt;fmt&gt;] &lt;device&gt;</pre>\r
 <div class="attribution">\r
 </div></div>\r
 </div>\r
@@ -755,7 +755,9 @@ nvme-list-subsys(1) Manual Page
 <h2 id="_description">DESCRIPTION</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p>Scan the sysfs tree for NVM Express subsystems and return the controllers\r
-for those subsystems as well as some pertinent information about them.</p></div>\r
+for those subsystems as well as some pertinent information about them.\r
+If a device is given, print out only the values for the controllers\r
+and subsystems leading to the device.</p></div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -780,7 +782,8 @@ for those subsystems as well as some pertinent information about them.</p></div>
 <div class="sect1">\r
 <h2 id="_examples">EXAMPLES</h2>\r
 <div class="sectionbody">\r
-<div class="paragraph"><p><a href="mailto:root@host">root@host</a># nvme list-subsys\r
+<div class="verseblock">\r
+<pre class="content"><a href="mailto:root@host">root@host</a># nvme list-subsys\r
 nvme-subsys0 - NQN=nvmf-test\r
 \\r
  +- nvme0 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.1\r
@@ -788,8 +791,11 @@ nvme-subsys0 - NQN=nvmf-test
 nvme-subsys1 - NQN=nvmf-test2\r
 \\r
  +- nvme2 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.2\r
- +- nvme3 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.1</p></div>\r
-<div class="paragraph"><p><a href="mailto:root@host">root@host</a># nvme list-subsys -o json\r
+ +- nvme3 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.1</pre>\r
+<div class="attribution">\r
+</div></div>\r
+<div class="verseblock">\r
+<pre class="content"><a href="mailto:root@host">root@host</a># nvme list-subsys -o json\r
 {\r
   "Subsystems" : [\r
     {\r
@@ -829,7 +835,9 @@ nvme-subsys1 - NQN=nvmf-test2
       ]\r
     }\r
   ]\r
-}</p></div>\r
+}</pre>\r
+<div class="attribution">\r
+</div></div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -842,7 +850,7 @@ nvme-subsys1 - NQN=nvmf-test2
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2017-12-13 08:23:17 MST\r
+Last updated 2018-11-16 09:53:53 MST\r
 </div>\r
 </div>\r
 </body>\r