From: Keith Busch Date: Wed, 13 Dec 2017 15:32:49 +0000 (-0700) Subject: Documentation fixes X-Git-Tag: v1.5~7 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=b6e29a75796b6700e8660e07085875a67deeb627;p=users%2Fsagi%2Fnvme-cli.git Documentation fixes Fixed asciidoc errors in set-properties, regenerated remaining documentation files for latest updates. Signed-off-by: Keith Busch --- diff --git a/Documentation/nvme-list-subsys.1 b/Documentation/nvme-list-subsys.1 new file mode 100644 index 00000000..3cbb9cd4 --- /dev/null +++ b/Documentation/nvme-list-subsys.1 @@ -0,0 +1,62 @@ +'\" t +.\" Title: nvme-list-subsys +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 12/13/2017 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-LIST\-SUBSYS" "1" "12/13/2017" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-list-subsys \- List all NVMe subsystems +.SH "SYNOPSIS" +.sp +.nf +\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\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR +or +\fIjson\fR\&. Only one output format can be used at a time\&. +.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 +.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" } ] } ] } +.SH "NVME" +.sp +Part of the nvme\-user suite +.SH "NOTES" +.IP " 1." 4 +root@host +.RS 4 +\%mailto:root@host +.RE diff --git a/Documentation/nvme-list-subsys.html b/Documentation/nvme-list-subsys.html new file mode 100644 index 00000000..0754f6cc --- /dev/null +++ b/Documentation/nvme-list-subsys.html @@ -0,0 +1,849 @@ + + + + + +nvme-list-subsys(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme list-subsys [-o <fmt> | --output-format=<fmt>]
+
+
+
+
+
+

DESCRIPTION

+
+

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

+
+
+
+

OPTIONS

+
+
+
+-o <format> +
+
+--output-format=<format> +
+
+

+ Set the reporting format to normal or json. Only one output + format can be used at a time. +

+
+
+
+
+
+

EXAMPLES

+
+

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 + +- nvme1 rdma traddr=1.1.1.3 trsvcid=4420 host_traddr=1.1.1.2 +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 +{ + "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" + } + ] + } + ] +}

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-set-property.1 b/Documentation/nvme-set-property.1 index 0ade1089..cf575f1c 100644 --- a/Documentation/nvme-set-property.1 +++ b/Documentation/nvme-set-property.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-set-property -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 06/28/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 12/13/2017 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-SET\-PROPERTY" "1" "11/24/2017" "NVMe" "NVMe Manual" +.TH "NVME\-SET\-PROPERTY" "1" "12/13/2017" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,24 +28,30 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -nvme-set-propery \- Writes and shows the defined NVMe controller property for NVMe ove Fabric +nvme-set-property \- Writes and shows the defined NVMe controller property for NVMe ove Fabric .SH "SYNOPSIS" .sp .nf -\fInvme set\-property\fR [\-\-offset= | \-n ] - [\-\-value= | \-v ] +\fInvme set\-property\fR [\-\-offset= | \-o ] + [\-\-value= | \-v ] .fi .SH "DESCRIPTION" .sp -Writes and shows the defined NVMe controller property for NVMe ove Fabric\&. Please use it carefully\&. +Writes and shows the defined NVMe controller property for NVMe ove Fabric\&. .SH "OPTIONS" .PP -\-o , \-\-offset= +\-o, \-\-offset .RS 4 The offset of the property\&. .RE -.SH "EXAMPLES" +.PP +\-v +.RS 4 +\-\-value: The value of the property to be set\&. .RE +.SH "EXAMPLES" +.sp +No examples (yet)\&. .SH "NVME" .sp Part of the nvme\-user suite diff --git a/Documentation/nvme-set-property.html b/Documentation/nvme-set-property.html index f1299379..9d883c73 100644 --- a/Documentation/nvme-set-property.html +++ b/Documentation/nvme-set-property.html @@ -1,814 +1,808 @@ - - - - - -nvme-set-property(1) - - - - - -
-
-

SYNOPSIS

-
-
-
nvme set-property <device> [--offset=<offset> | -o <offset> ]
-	 					[--value=<val> | -v <val> ]
-
-
-
-
-
-

DESCRIPTION

-
-

Writes and shows the defined NVMe controller property for NVMe ove Fabric.

-
-
-
-

OPTIONS

-
-
-
--o -
-
---offset -
-
-

- The offset of the property -

-
-
-
--v -
-
---value -
-
-

- The value of the property to be set -

-
-
-
-
-
-

EXAMPLES

-
-
    -
  • -
    -
    -
    -
    -
    -

    NVME

    -
    -

    Part of the nvme-user suite

    -
    -
    -
-
- - - + + + + + +nvme-set-property(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme set-property <device> [--offset=<offset> | -o <offset>]
+                                [--value=<val> | -v <val>]
+
+
+
+
+
+

DESCRIPTION

+
+

Writes and shows the defined NVMe controller property for NVMe ove Fabric.

+
+
+
+

OPTIONS

+
+
+
+-o +
+
+--offset +
+
+

+ The offset of the property. +

+
+
+-v +
+
+

+--value: + The value of the property to be set. +

+
+
+
+
+
+

EXAMPLES

+
+

No examples (yet).

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-set-property.txt b/Documentation/nvme-set-property.txt index 7c490588..0d04f52e 100644 --- a/Documentation/nvme-set-property.txt +++ b/Documentation/nvme-set-property.txt @@ -1,5 +1,5 @@ nvme-set-property(1) -============= +==================== NAME ---- @@ -9,25 +9,27 @@ for NVMe ove Fabric SYNOPSIS -------- [verse] -'nvme set-property' [--offset= | -o ] [--value= | -v ] +'nvme set-property' [--offset= | -o ] + [--value= | -v ] DESCRIPTION ----------- -Writes and shows the defined NVMe controller property for NVMe ove Fabric +Writes and shows the defined NVMe controller property for NVMe ove Fabric. OPTIONS ------- -o:: --offset:: - The offset of the property + The offset of the property. -v:: --value: - The value of the property to be set + The value of the property to be set. EXAMPLES -------- +No examples (yet). NVME ---- diff --git a/Documentation/nvme-show-regs.1 b/Documentation/nvme-show-regs.1 index b476e375..47b317fa 100644 --- a/Documentation/nvme-show-regs.1 +++ b/Documentation/nvme-show-regs.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-id-ns -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 12/13/2017 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-ID\-NS" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-ID\-NS" "1" "12/13/2017" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,7 +28,7 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -nvme-show-regs \- Reads and shows the defined NVMe controller registers\&. +nvme-show-regs \- Reads and shows the defined NVMe controller registers for NVMe over PCIe or the controller properties for NVMe over Fabrics\&. .SH "SYNOPSIS" .sp .nf @@ -36,14 +36,14 @@ nvme-show-regs \- Reads and shows the defined NVMe controller registers\&. .fi .SH "DESCRIPTION" .sp -For the NVMe device given, sends an identify namespace command and provides the result and returned structure\&. +For the NVMe over PCIe device given, sends an identify namespace command and provides the result and returned structure\&. For the NVMe over Fabrics device given, sends a fabric command and provides the result and returned structure\&. .sp -The parameter is mandatory and must be the nvme admin character device (ex: /dev/nvme0)\&. The program uses knowledge of the sysfs layout to map the device to the pci resource stored there and mmaps the memory to get access to the registers\&. +The parameter is mandatory and must be the nvme admin character device (ex: /dev/nvme0)\&. For NVMe over PCIe, the program uses knowledge of the sysfs layout to map the device to the pci resource stored there and mmaps the memory to get access to the registers\&. For NVMe over Fabrics, the programs sends a fabric command to get the properties of the target NVMe controller\&. Only the supported properties are displayed\&. .SH "OPTIONS" .PP \-H, \-\-human\-readable .RS 4 -Display registers in human readable format\&. +Display registers or supported properties in human readable format\&. .RE .SH "EXAMPLES" .sp @@ -55,7 +55,7 @@ Display registers in human readable format\&. .sp -1 .IP \(bu 2.3 .\} -Show the nvme pci controller registers in a binary format: +Show the NVMe over PCIe controller registers or the NVMe over Fabric controller properties in a binary format: .sp .if n \{\ .RS 4 @@ -76,7 +76,7 @@ Show the nvme pci controller registers in a binary format: .sp -1 .IP \(bu 2.3 .\} -Show the nvme pci controller registers in a human readable format: +Show the NVMe over PCIe controller registers or the NVMe over Fabric controller properties in a human readable format: .sp .if n \{\ .RS 4 diff --git a/Documentation/nvme-show-regs.html b/Documentation/nvme-show-regs.html index 439220b4..9c2e65e9 100644 --- a/Documentation/nvme-show-regs.html +++ b/Documentation/nvme-show-regs.html @@ -737,7 +737,7 @@ nvme-id-ns(1) Manual Page

NAME

nvme-show-regs - - Reads and shows the defined NVMe controller registers. + Reads and shows the defined NVMe controller registers for NVMe over PCIe or the controller properties for NVMe over Fabrics.

@@ -754,12 +754,16 @@ nvme-id-ns(1) Manual Page

DESCRIPTION

-

For the NVMe device given, sends an identify namespace command and -provides the result and returned structure.

+

For the NVMe over PCIe device given, sends an identify namespace command and +provides the result and returned structure. +For the NVMe over Fabrics device given, sends a fabric command and provides +the result and returned structure.

The <device> parameter is mandatory and must be the nvme admin character -device (ex: /dev/nvme0). The program uses knowledge of the sysfs layout -to map the device to the pci resource stored there and mmaps the memory -to get access to the registers.

+device (ex: /dev/nvme0). For NVMe over PCIe, the program uses knowledge of the +sysfs layout to map the device to the pci resource stored there and mmaps the +memory to get access to the registers. For NVMe over Fabrics, the programs +sends a fabric command to get the properties of the target NVMe controller. +Only the supported properties are displayed.

@@ -774,7 +778,7 @@ to get access to the registers.

- Display registers in human readable format. + Display registers or supported properties in human readable format.

@@ -786,7 +790,8 @@ to get access to the registers.

  • -Show the nvme pci controller registers in a binary format: +Show the NVMe over PCIe controller registers or the NVMe over Fabric controller +properties in a binary format:

    @@ -795,7 +800,8 @@ Show the nvme pci controller registers in a binary format:

  • -Show the nvme pci controller registers in a human readable format: +Show the NVMe over PCIe controller registers or the NVMe over Fabric controller +properties in a human readable format:

    @@ -815,7 +821,7 @@ Show the nvme pci controller registers in a human readable format:
    diff --git a/Documentation/nvme-write.1 b/Documentation/nvme-write.1 index 81871061..fac48026 100644 --- a/Documentation/nvme-write.1 +++ b/Documentation/nvme-write.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme-write -.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] -.\" Generator: DocBook XSL Stylesheets v1.79.1 -.\" Date: 12/10/2017 +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 12/13/2017 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WRITE" "1" "12/10/2017" "NVMe" "NVMe Manual" +.TH "NVME\-WRITE" "1" "12/13/2017" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------