Skip to content

Commit

Permalink
doc: Regenerate all docs for v2.8
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Wagner <[email protected]>
  • Loading branch information
igaw committed Feb 14, 2024
1 parent 729bf74 commit 43b716b
Show file tree
Hide file tree
Showing 380 changed files with 642 additions and 601 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: 12/21/2023
.\" Date: 02/14/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ADMIN\-PASSTHR" "1" "12/21/2023" "NVMe" "NVMe Manual"
.TH "NVME\-ADMIN\-PASSTHR" "1" "02/14/2024" "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 @@ -1027,7 +1027,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2023-12-21 15:49:29 CET
2024-02-14 10:43:42 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: 12/21/2023
.\" Date: 02/14/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ANA\-LOG" "1" "12/21/2023" "NVMe" "NVMe Manual"
.TH "NVME\-ANA\-LOG" "1" "02/14/2024" "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 @@ -835,7 +835,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2023-12-21 15:49:29 CET
2024-02-14 10:43:42 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: 12/21/2023
.\" Date: 02/14/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ATTACH\-NS" "1" "12/21/2023" "NVMe" "NVMe Manual"
.TH "NVME\-ATTACH\-NS" "1" "02/14/2024" "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 @@ -841,7 +841,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2023-12-21 15:49:29 CET
2024-02-14 10:43:42 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: 12/21/2023
.\" Date: 02/14/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-BOOT\-PART\-LO" "1" "12/21/2023" "NVMe" "NVMe Manual"
.TH "NVME\-BOOT\-PART\-LO" "1" "02/14/2024" "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 @@ -846,7 +846,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2023-12-21 15:49:29 CET
2024-02-14 10:43:42 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: 12/21/2023
.\" Date: 02/14/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CAPACITY\-MGMT" "1" "12/21/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CAPACITY\-MGMT" "1" "02/14/2024" "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 @@ -863,7 +863,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2023-12-21 15:49:29 CET
2024-02-14 10:43:42 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: 12/21/2023
.\" Date: 02/14/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CHANGED\-NS\-L" "1" "12/21/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CHANGED\-NS\-L" "1" "02/14/2024" "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 @@ -846,7 +846,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2023-12-21 15:49:29 CET
2024-02-14 10:43:42 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: 12/21/2023
.\" Date: 02/14/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CMDSET\-IND\-I" "1" "12/21/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CMDSET\-IND\-I" "1" "02/14/2024" "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 @@ -889,7 +889,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2023-12-21 15:49:29 CET
2024-02-14 10:43:42 CET
</div>
</div>
</body>
Expand Down
4 changes: 2 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: 12/21/2023
.\" Date: 02/14/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-COMPARE" "1" "12/21/2023" "NVMe" "NVMe Manual"
.TH "NVME\-COMPARE" "1" "02/14/2024" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/nvme-compare.html
Original file line number Diff line number Diff line change
Expand Up @@ -1116,7 +1116,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2023-12-21 15:49:29 CET
2024-02-14 10:43:42 CET
</div>
</div>
</body>
Expand Down
17 changes: 11 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: 12/21/2023
.\" Date: 02/14/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CONNECT\-ALL" "1" "12/21/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CONNECT\-ALL" "1" "02/14/2024" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -42,7 +42,7 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
[\-\-hostid=<hostid> | \-I <hostid>]
[\-\-raw=<filename> | \-r <filename>]
[\-\-device=<device> | \-d <device>]
[\-\-cfg\-file=<cfg> | \-C <cfg>]
[\-\-config=<filename> | \-J <cfg>]
[\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
[\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
Expand All @@ -51,7 +51,7 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
[\-\-nr\-poll\-queues=<#> | \-P <#>]
[\-\-queue\-size=<#> | \-Q <#>] [\-\-keyring=<#>]
[\-\-tls_key=<#>] [\-\-hdr\-digest | \-g] [\-\-data\-digest | \-G]
[\-\-persistent | \-p] [\-\-tls] [\-\-quiet | \-S]
[\-\-persistent | \-p] [\-\-tls] [\-\-concat] [\-\-quiet | \-S]
[\-\-dump\-config | \-O] [\-\-nbft] [\-\-no\-nbft]
[\-\-nbft\-path=<STR>] [\-\-context=<STR>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
Expand Down Expand Up @@ -156,12 +156,12 @@ will dump the output to stdout\&.
This field takes a device as input\&. It must be a persistent device associated with a Discovery Controller previously created by the command "connect\-all" or "discover"\&. <device> follows the format nvme*, eg\&. nvme0, nvme1\&.
.RE
.PP
\-C <cfg>, \-\-config\-file=<cfg>
\-J <filename>, \-\-config=<filename>
.RS 4
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[]
\m[blue]\fBhttps://github\&.com/linux\-nvme/libnvme/blob/master/doc/config\-schema\&.json\fR\m[]
.RE
.PP
\-k <#>, \-\-keep\-alive\-tmo=<#>
Expand Down Expand Up @@ -229,6 +229,11 @@ Don\(cqt remove the discovery controller after retrieving the discovery log page
Enable TLS encryption (TCP)\&.
.RE
.PP
\-\-concat
.RS 4
Enable secure concatenation (TCP)\&.
.RE
.PP
\-S, \-\-quiet
.RS 4
Suppress error messages\&.
Expand Down
20 changes: 14 additions & 6 deletions Documentation/nvme-connect-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -759,7 +759,7 @@ <h2 id="_synopsis">SYNOPSIS</h2>
[--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;]
[--raw=&lt;filename&gt; | -r &lt;filename&gt;]
[--device=&lt;device&gt; | -d &lt;device&gt;]
[--cfg-file=&lt;cfg&gt; | -C &lt;cfg&gt;]
[--config=&lt;filename&gt; | -J &lt;cfg&gt;]
[--keep-alive-tmo=&lt;sec&gt; | -k &lt;sec&gt;]
[--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;]
[--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;]
Expand All @@ -768,7 +768,7 @@ <h2 id="_synopsis">SYNOPSIS</h2>
[--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;]
[--queue-size=&lt;#&gt; | -Q &lt;#&gt;] [--keyring=&lt;#&gt;]
[--tls_key=&lt;#&gt;] [--hdr-digest | -g] [--data-digest | -G]
[--persistent | -p] [--tls] [--quiet | -S]
[--persistent | -p] [--tls] [--concat] [--quiet | -S]
[--dump-config | -O] [--nbft] [--no-nbft]
[--nbft-path=&lt;STR&gt;] [--context=&lt;STR&gt;]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
Expand Down Expand Up @@ -959,18 +959,18 @@ <h2 id="_options">OPTIONS</h2>
</p>
</dd>
<dt class="hdlist1">
-C &lt;cfg&gt;
-J &lt;filename&gt;
</dt>
<dt class="hdlist1">
--config-file=&lt;cfg&gt;
--config=&lt;filename&gt;
</dt>
<dd>
<p>
Use the specified JSON configuration file instead of the
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>
<a href="https://github.com/linux-nvme/libnvme/blob/master/doc/config-schema.json">https://github.com/linux-nvme/libnvme/blob/master/doc/config-schema.json</a>
</p>
</dd>
<dt class="hdlist1">
Expand Down Expand Up @@ -1116,6 +1116,14 @@ <h2 id="_options">OPTIONS</h2>
</p>
</dd>
<dt class="hdlist1">
--concat
</dt>
<dd>
<p>
Enable secure concatenation (TCP).
</p>
</dd>
<dt class="hdlist1">
-S
</dt>
<dt class="hdlist1">
Expand Down Expand Up @@ -1268,7 +1276,7 @@ <h2 id="_nvme">NVME</h2>
<div id="footer">
<div id="footer-text">
Last updated
2023-12-21 15:49:29 CET
2024-02-14 10:43:42 CET
</div>
</div>
</body>
Expand Down
17 changes: 11 additions & 6 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: 12/21/2023
.\" Date: 02/14/2024
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CONNECT" "1" "12/21/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CONNECT" "1" "02/14/2024" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down Expand Up @@ -40,7 +40,7 @@ nvme-connect \- Connect to a Fabrics controller\&.
[\-\-host\-iface=<iface> | \-f <iface>]
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
[\-\-hostid=<hostid> | \-I <hostid>]
[\-\-config\-file=<cfg> | \-J <cfg>]
[\-\-config=<filename> | \-J <filename>]
[\-\-dhchap\-secret=<secret> | \-S <secret>]
[\-\-dhchap\-ctrl\-secret=<secret> | \-C <secret>]
[\-\-nr\-io\-queues=<#> | \-i <#>]
Expand All @@ -53,7 +53,7 @@ nvme-connect \- Connect to a Fabrics controller\&.
[\-\-keyring=<#>] [\-\-tls_key=<#>]
[\-\-duplicate\-connect | \-D] [\-\-disable\-sqflow | \-d]
[\-\-hdr\-digest | \-g] [\-\-data\-digest | \-G] [\-\-tls]
[\-\-dump\-config | \-O] [\-\-application=<id>]
[\-\-concat] [\-\-dump\-config | \-O] [\-\-application=<id>]
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
Expand Down Expand Up @@ -136,12 +136,12 @@ Overrides the default Host NQN that identifies the NVMe Host\&. If this option i
UUID(Universally Unique Identifier) to be discovered which should be formatted\&.
.RE
.PP
\-J <cfg>, \-\-config\-file=<cfg>
\-J <filename>, \-\-config=<filename>
.RS 4
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[]
\m[blue]\fBhttps://github\&.com/linux\-nvme/libnvme/blob/master/doc/config\-schema\&.json\fR\m[]
.RE
.PP
\-S <secret>, \-\-dhchap\-secret=<secret>
Expand Down Expand Up @@ -231,6 +231,11 @@ Generates/verifies data digest (TCP)\&.
Enable TLS encryption (TCP)\&.
.RE
.PP
\-\-concat
.RS 4
Enable secure concatenation (TCP)\&.
.RE
.PP
\-O, \-\-dump\-config
.RS 4
Print out resulting JSON configuration file to stdout\&.
Expand Down
Loading

0 comments on commit 43b716b

Please sign in to comment.