Skip to content

Commit

Permalink
doc: Regenerate all docs for v2.3
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Wagner <[email protected]>
  • Loading branch information
igaw committed Jan 30, 2023
1 parent 7cb519e commit 137fb15
Show file tree
Hide file tree
Showing 372 changed files with 10,590 additions and 591 deletions.
4 changes: 2 additions & 2 deletions Documentation/nvme-admin-passthru.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: nvme-admin-passthru
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/02/2022
.\" Date: 01/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ADMIN\-PASSTHR" "1" "11/02/2022" "NVMe" "NVMe Manual"
.TH "NVME\-ADMIN\-PASSTHR" "1" "01/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/nvme-admin-passthru.html
Original file line number Diff line number Diff line change
Expand Up @@ -998,7 +998,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2022-11-02 16:43:53 CET
2023-01-30 14:14:16 CET
</div>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions Documentation/nvme-ana-log.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: nvme-ana-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/02/2022
.\" Date: 01/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ANA\-LOG" "1" "11/02/2022" "NVMe" "NVMe Manual"
.TH "NVME\-ANA\-LOG" "1" "01/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/nvme-ana-log.html
Original file line number Diff line number Diff line change
Expand Up @@ -823,7 +823,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2022-11-02 16:43:53 CET
2023-01-30 14:14:16 CET
</div>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions Documentation/nvme-attach-ns.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: nvme-attach-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/02/2022
.\" Date: 01/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ATTACH\-NS" "1" "11/02/2022" "NVMe" "NVMe Manual"
.TH "NVME\-ATTACH\-NS" "1" "01/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/nvme-attach-ns.html
Original file line number Diff line number Diff line change
Expand Up @@ -817,7 +817,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2022-11-02 16:43:53 CET
2023-01-30 14:14:16 CET
</div>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions Documentation/nvme-boot-part-log.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: nvme-boot-part-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/02/2022
.\" Date: 01/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-BOOT\-PART\-LO" "1" "11/02/2022" "NVMe" "NVMe Manual"
.TH "NVME\-BOOT\-PART\-LO" "1" "01/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/nvme-boot-part-log.html
Original file line number Diff line number Diff line change
Expand Up @@ -835,7 +835,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2022-11-02 16:43:53 CET
2023-01-30 14:14:16 CET
</div>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions Documentation/nvme-capacity-mgmt.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: nvme-capacity-mgmt
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/02/2022
.\" Date: 01/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CAPACITY\-MGMT" "1" "11/02/2022" "NVMe" "NVMe Manual"
.TH "NVME\-CAPACITY\-MGMT" "1" "01/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/nvme-capacity-mgmt.html
Original file line number Diff line number Diff line change
Expand Up @@ -839,7 +839,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2022-11-02 16:43:53 CET
2023-01-30 14:14:16 CET
</div>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions Documentation/nvme-changed-ns-list-log.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: nvme-changed-ns-list-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/02/2022
.\" Date: 01/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CHANGED\-NS\-L" "1" "11/02/2022" "NVMe" "NVMe Manual"
.TH "NVME\-CHANGED\-NS\-L" "1" "01/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/nvme-changed-ns-list-log.html
Original file line number Diff line number Diff line change
Expand Up @@ -835,7 +835,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2022-11-02 16:43:53 CET
2023-01-30 14:14:16 CET
</div>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions Documentation/nvme-cmdset-ind-id-ns.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: nvme-cmdset-ind-id-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/02/2022
.\" Date: 01/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CMDSET\-IND\-I" "1" "11/02/2022" "NVMe" "NVMe Manual"
.TH "NVME\-CMDSET\-IND\-I" "1" "01/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/nvme-cmdset-ind-id-ns.html
Original file line number Diff line number Diff line change
Expand Up @@ -879,7 +879,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2022-11-02 16:43:53 CET
2023-01-30 14:14:16 CET
</div>
</div>
</body>
Expand Down
10 changes: 8 additions & 2 deletions Documentation/nvme-compare.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: nvme-compare
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/02/2022
.\" Date: 01/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-COMPARE" "1" "11/02/2022" "NVMe" "NVMe Manual"
.TH "NVME\-COMPARE" "1" "01/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -50,6 +50,7 @@ nvme-compare \- Send an NVMe Compare command, provide results
[\-\-show\-command | \-v]
[\-\-dry\-run | \-w]
[\-\-latency | \-t]
[\-\-storage\-tag<storage\-tag> | \-g <storage\-tag>]
[\-\-storage\-tag\-check<storage\-tag\-check> | \-C <storage\-tag\-check>]
[\-\-force]
.fi
Expand Down Expand Up @@ -205,6 +206,11 @@ be set\&. Otherwise \-\-dry\-run option will be
Print out the latency the IOCTL took (in us)\&.
.RE
.PP
\-\-storage\-tag=<storage\-tag>, \-g <storage\-tag>
.RS 4
Variable Sized Expected Logical Block Storage Tag(ELBST)\&.
.RE
.PP
\-\-storage\-tag\-check=<storage\-tag\-check>, \-C <storage\-tag\-check>
.RS 4
This bit specifies the Storage Tag field shall be checked as part of end\-to\-end data protection processing\&.
Expand Down
14 changes: 13 additions & 1 deletion Documentation/nvme-compare.html
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,7 @@ <h2 id="_synopsis">SYNOPSIS</h2>
[--show-command | -v]
[--dry-run | -w]
[--latency | -t]
[--storage-tag&lt;storage-tag&gt; | -g &lt;storage-tag&gt;]
[--storage-tag-check&lt;storage-tag-check&gt; | -C &lt;storage-tag-check&gt;]
[--force]</pre>
<div class="attribution">
Expand Down Expand Up @@ -1043,6 +1044,17 @@ <h2 id="_options">OPTIONS</h2>
</p>
</dd>
<dt class="hdlist1">
--storage-tag=&lt;storage-tag&gt;
</dt>
<dt class="hdlist1">
-g &lt;storage-tag&gt;
</dt>
<dd>
<p>
Variable Sized Expected Logical Block Storage Tag(ELBST).
</p>
</dd>
<dt class="hdlist1">
--storage-tag-check=&lt;storage-tag-check&gt;
</dt>
<dt class="hdlist1">
Expand Down Expand Up @@ -1083,7 +1095,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2022-11-02 16:43:53 CET
2023-01-30 14:14:16 CET
</div>
</div>
</body>
Expand Down
12 changes: 6 additions & 6 deletions Documentation/nvme-connect-all.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: nvme-connect-all
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/02/2022
.\" Date: 01/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CONNECT\-ALL" "1" "11/02/2022" "NVMe" "NVMe Manual"
.TH "NVME\-CONNECT\-ALL" "1" "01/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -60,7 +60,7 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
.sp
Send one or more Discovery requests to a NVMe over Fabrics Discovery Controller, and create controllers for the returned discovery records\&.
.sp
If no parameters are given, then \fInvme connect\-all\fR will attempt to find a /etc/nvme/discovery\&.conf file to use to supply a list of connect\-all commands to run\&. If no /etc/nvme/discovery\&.conf file exists, the command will quit with an error\&.
If no parameters are given, then \fInvme connect\-all\fR will attempt to find a /usr/local/etc/nvme/discovery\&.conf file to use to supply a list of connect\-all commands to run\&. If no /usr/local/etc/nvme/discovery\&.conf file exists, the command will quit with an error\&.
.sp
Otherwise a specific Discovery Controller should be specified using the \-\-transport, \-\-traddr and if necessary the \-\-trsvcid and a Discovery request will be sent to the specified Discovery Controller\&.
.sp
Expand Down Expand Up @@ -134,7 +134,7 @@ This field specifies the network interface used on the host to connect to the Co
.PP
\-q <hostnqn>, \-\-hostnqn=<hostnqn>
.RS 4
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, and may be used by the the Discovery Controller to control what NVMe Target resources are allocated to the NVMe Host for a connection\&.
Overrides the default Host NQN that identifies the NVMe Host\&. If this option is not specified, the default is read from /usr/local/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, and may be used by the the Discovery Controller to control what NVMe Target resources are allocated to the NVMe Host for a connection\&.
.RE
.PP
\-I <hostid>, \-\-hostid=<hostid>
Expand All @@ -153,7 +153,7 @@ will dump the output to stdout\&.
.PP
\-C <cfg>, \-\-config\-file=<cfg>
.RS 4
Use the specified JSON configuration file instead of the default /etc/nvme/config\&.json file or
Use the specified JSON configuration file instead of the default /usr/local/etc/nvme/config\&.json file or
\fInone\fR
to not read in an existing configuration file\&. The JSON configuration file format is documented in
\m[blue]\fBhttps://github\&.com/linux\-nvme/libnvme/doc/config\-schema\&.json\fR\m[]
Expand Down Expand Up @@ -252,7 +252,7 @@ Connect to all records returned by the Discover Controller with IP4 address 192\
.\}
Issue a
\fInvme connect\-all\fR
command using a /etc/nvme/discovery\&.conf file:
command using a /usr/local/etc/nvme/discovery\&.conf file:
.sp
.if n \{\
.RS 4
Expand Down
12 changes: 6 additions & 6 deletions Documentation/nvme-connect-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -782,8 +782,8 @@ <h2 id="_description">DESCRIPTION</h2>
<div class="paragraph"><p>Send one or more Discovery requests to a NVMe over Fabrics Discovery
Controller, and create controllers for the returned discovery records.</p></div>
<div class="paragraph"><p>If no parameters are given, then <em>nvme connect-all</em> will attempt to
find a /etc/nvme/discovery.conf file to use to supply a list of
connect-all commands to run. If no /etc/nvme/discovery.conf file
find a /usr/local/etc/nvme/discovery.conf file to use to supply a list of
connect-all commands to run. If no /usr/local/etc/nvme/discovery.conf file
exists, the command will quit with an error.</p></div>
<div class="paragraph"><p>Otherwise a specific Discovery Controller should be specified using the
--transport, --traddr and if necessary the --trsvcid and a Discovery
Expand Down Expand Up @@ -912,7 +912,7 @@ <h2 id="_options">OPTIONS</h2>
<p>
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
/usr/local/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, and may be used by the
the Discovery Controller to control what NVMe Target resources are
Expand Down Expand Up @@ -953,7 +953,7 @@ <h2 id="_options">OPTIONS</h2>
<dd>
<p>
Use the specified JSON configuration file instead of the
default /etc/nvme/config.json file or <em>none</em> to not read in
default /usr/local/etc/nvme/config.json file or <em>none</em> to not read in
an existing configuration file. The JSON configuration file
format is documented in
<a href="https://github.com/linux-nvme/libnvme/doc/config-schema.json">https://github.com/linux-nvme/libnvme/doc/config-schema.json</a>
Expand Down Expand Up @@ -1120,7 +1120,7 @@ <h2 id="_examples">EXAMPLES</h2>
</li>
<li>
<p>
Issue a <em>nvme connect-all</em> command using a /etc/nvme/discovery.conf file:
Issue a <em>nvme connect-all</em> command using a /usr/local/etc/nvme/discovery.conf file:
</p>
<div class="listingblock">
<div class="content">
Expand Down Expand Up @@ -1156,7 +1156,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2022-11-02 16:43:53 CET
2023-01-30 14:14:16 CET
</div>
</div>
</body>
Expand Down
10 changes: 5 additions & 5 deletions Documentation/nvme-connect.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
.\" Title: nvme-connect
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 11/02/2022
.\" Date: 01/30/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CONNECT" "1" "11/02/2022" "NVMe" "NVMe Manual"
.TH "NVME\-CONNECT" "1" "01/30/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -130,7 +130,7 @@ This field specifies the network interface used on the host to connect to the Co
.PP
\-q <hostnqn>, \-\-hostnqn=<hostnqn>
.RS 4
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\&.
Overrides the default Host NQN that identifies the NVMe Host\&. If this option is not specified, the default is read from /usr/local/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>
Expand All @@ -140,7 +140,7 @@ UUID(Universally Unique Identifier) to be discovered which should be formatted\&
.PP
\-J <cfg>, \-\-config\-file=<cfg>
.RS 4
Use the specified JSON configuration file instead of the default /etc/nvme/config\&.json file or
Use the specified JSON configuration file instead of the default /usr/local/etc/nvme/config\&.json file or
\fInone\fR
to not read in an existing configuration file\&. The JSON configuration file format is documented in
\m[blue]\fBhttps://github\&.com/linux\-nvme/libnvme/doc/config\-schema\&.json\fR\m[]
Expand All @@ -149,7 +149,7 @@ to not read in an existing configuration file\&. The JSON configuration file for
\-S <secret>, \-\-dhchap\-secret=<secret>
.RS 4
NVMe In\-band authentication secret; needs to be in ASCII format as specified in NVMe 2\&.0 section 8\&.13\&.5\&.8
\fISecret representation\fR\&. If this option is not specified, the default is read from /etc/nvme/hostkey\&. If that does not exist no in\-band authentication is attempted\&.
\fISecret representation\fR\&. If this option is not specified, the default is read from /usr/local/etc/nvme/hostkey\&. If that does not exist no in\-band authentication is attempted\&.
.RE
.PP
\-C <secret>, \-\-dhchap\-ctrl\-secret=<secret>
Expand Down
Loading

0 comments on commit 137fb15

Please sign in to comment.