From dd6a69ce58cec80e798252d2b1418f8e1f8cf03c Mon Sep 17 00:00:00 2001 From: Keith Busch Date: Fri, 16 Nov 2018 09:55:02 -0700 Subject: [PATCH] Regen documentation Update manpages with latest doc updates. Signed-off-by: Keith Busch --- Documentation/nvme-list-subsys.1 | 76 ++++++++++++++++++++++++++--- Documentation/nvme-list-subsys.html | 22 ++++++--- 2 files changed, 85 insertions(+), 13 deletions(-) diff --git a/Documentation/nvme-list-subsys.1 b/Documentation/nvme-list-subsys.1 index 34be6dd8..f521d0c9 100644 --- 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 -.\" 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 | \-\-output\-format=] +\fInvme list\-subsys\fR [\-o | \-\-output\-format=] .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 , \-\-output\-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 0754f6cc..f3a1e9bf 100644 --- a/Documentation/nvme-list-subsys.html +++ b/Documentation/nvme-list-subsys.html @@ -746,7 +746,7 @@ nvme-list-subsys(1) Manual Page

SYNOPSIS

-
nvme list-subsys [-o <fmt> | --output-format=<fmt>]
+
nvme list-subsys [-o <fmt> | --output-format=<fmt>] <device>
@@ -755,7 +755,9 @@ nvme-list-subsys(1) Manual Page

DESCRIPTION

Scan the sysfs tree for NVM Express subsystems and return the controllers -for those subsystems as well as some pertinent information about them.

+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.

@@ -780,7 +782,8 @@ for those subsystems as well as some pertinent information about them.

EXAMPLES

-

root@host# nvme list-subsys +

+
root@host# nvme list-subsys
 nvme-subsys0 - NQN=nvmf-test
 \
  +- nvme0 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.1
@@ -788,8 +791,11 @@ nvme-subsys0 - NQN=nvmf-test
 nvme-subsys1 - NQN=nvmf-test2
 \
  +- 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
-

root@host# nvme list-subsys -o json + +- nvme3 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.1 +

+
+
+
root@host# nvme list-subsys -o json
 {
   "Subsystems" : [
     {
@@ -829,7 +835,9 @@ nvme-subsys1 - NQN=nvmf-test2
       ]
     }
   ]
-}
+} +
+
@@ -842,7 +850,7 @@ nvme-subsys1 - NQN=nvmf-test2
-- 2.50.1