doc: Regenerate all docs for v2.5

Signed-off-by: Daniel Wagner <[email protected]>
linux-nvme · Jun 30, 2023 · d6c07e0 · d6c07e0
1 parent a10a222
commit d6c07e0
Show file tree

Hide file tree

Showing 380 changed files with 4,952 additions and 595 deletions.
diff --git a/Documentation/nvme-admin-passthru.1 b/Documentation/nvme-admin-passthru.1
@@ -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: 03/31/2023
+.\" Date: 06/30/2023
 .\" Manual: NVMe Manual
 .\" Source: NVMe
 .\" Language: English
 .\"
-.TH "NVME\-ADMIN\-PASSTHR" "1" "03/31/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ADMIN\-PASSTHR" "1" "06/30/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -34,9 +34,11 @@ nvme-admin-passthru \- Submit an arbitrary admin command, return results
 .nf
 \fInvme\-admin\-passthru\fR <device> [\-\-opcode=<opcode> | \-o <opcode>]
  [\-\-flags=<flags> | \-f <flags>] [\-rsvd=<rsvd> | \-R <rsvd>]
- [\-\-namespace\-id=<nsid>] [\-\-cdw2=<cdw2>] [\-\-cdw3=<cdw3>]
- [\-\-cdw10=<cdw10>] [\-\-cdw11=<cdw11>] [\-\-cdw12=<cdw12>]
- [\-\-cdw13=<cdw13>] [\-\-cdw14=<cdw14>] [\-\-cdw15=<cdw15>]
+ [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-cdw2=<cdw2> | \-2 <cdw2>]
+ [\-\-cdw3=<cdw3> | \-3 <cdw3>] [\-\-cdw10=<cdw10> | \-4 <cdw4>]
+ [\-\-cdw11=<cdw11> | \-5 <cdw5>] [\-\-cdw12=<cdw12> | \-6 <cdw6>]
+ [\-\-cdw13=<cdw13> | \-7 <cdw7>] [\-\-cdw14=<cdw14> | \-8 <cdw8>]
+ [\-\-cdw15=<cdw15> | \-9 <cdw9>]
  [\-\-data\-len=<data\-len> | \-l <data\-len>]
  [\-\-metadata\-len=<len> | \-m <len>]
  [\-\-input\-file=<file> | \-i <file>]
@@ -77,7 +79,7 @@ The value for the reserved field in the command\&.
 The value for the ns\-id in the command\&.
 .RE
 .PP
-\-\-cdw[2\-3,10\-15]=<cdw>
+\-[2\-9] <cdw>, \-\-cdw[2\-3,10\-15]=<cdw>
 .RS 4
 Specifies the command dword value for that specified entry in the command
 .RE

diff --git a/Documentation/nvme-admin-passthru.html b/Documentation/nvme-admin-passthru.html
@@ -751,9 +751,11 @@ <h2 id="_synopsis">SYNOPSIS</h2>
 <div class="verseblock">
 <pre class="content"><em>nvme-admin-passthru</em> &lt;device&gt; [--opcode=&lt;opcode&gt; | -o &lt;opcode&gt;]
  [--flags=&lt;flags&gt; | -f &lt;flags&gt;] [-rsvd=&lt;rsvd&gt; | -R &lt;rsvd&gt;]
- [--namespace-id=&lt;nsid&gt;] [--cdw2=&lt;cdw2&gt;] [--cdw3=&lt;cdw3&gt;]
- [--cdw10=&lt;cdw10&gt;] [--cdw11=&lt;cdw11&gt;] [--cdw12=&lt;cdw12&gt;]
- [--cdw13=&lt;cdw13&gt;] [--cdw14=&lt;cdw14&gt;] [--cdw15=&lt;cdw15&gt;]
+ [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;] [--cdw2=&lt;cdw2&gt; | -2 &lt;cdw2&gt;]
+ [--cdw3=&lt;cdw3&gt; | -3 &lt;cdw3&gt;] [--cdw10=&lt;cdw10&gt; | -4 &lt;cdw4&gt;]
+ [--cdw11=&lt;cdw11&gt; | -5 &lt;cdw5&gt;] [--cdw12=&lt;cdw12&gt; | -6 &lt;cdw6&gt;]
+ [--cdw13=&lt;cdw13&gt; | -7 &lt;cdw7&gt;] [--cdw14=&lt;cdw14&gt; | -8 &lt;cdw8&gt;]
+ [--cdw15=&lt;cdw15&gt; | -9 &lt;cdw9&gt;]
  [--data-len=&lt;data-len&gt; | -l &lt;data-len&gt;]
  [--metadata-len=&lt;len&gt; | -m &lt;len&gt;]
  [--input-file=&lt;file&gt; | -i &lt;file&gt;]
@@ -832,6 +834,9 @@ <h2 id="_options">OPTIONS</h2>
 </p>
 </dd>
 <dt class="hdlist1">
+-[2-9] &lt;cdw&gt;
+</dt>
+<dt class="hdlist1">
 --cdw[2-3,10-15]=&lt;cdw&gt;
 </dt>
 <dd>
@@ -998,7 +1003,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-03-31 16:17:28 CEST
+ 2023-06-30 15:20:22 CEST
 </div>
 </div>
 </body>

diff --git a/Documentation/nvme-ana-log.1 b/Documentation/nvme-ana-log.1
@@ -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: 03/31/2023
+.\" Date: 06/30/2023
 .\" Manual: NVMe Manual
 .\" Source: NVMe
 .\" Language: English
 .\"
-.TH "NVME\-ANA\-LOG" "1" "03/31/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ANA\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

diff --git a/Documentation/nvme-ana-log.html b/Documentation/nvme-ana-log.html
@@ -823,7 +823,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-03-31 16:17:28 CEST
+ 2023-06-30 15:20:22 CEST
 </div>
 </div>
 </body>

diff --git a/Documentation/nvme-attach-ns.1 b/Documentation/nvme-attach-ns.1
@@ -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: 03/31/2023
+.\" Date: 06/30/2023
 .\" Manual: NVMe Manual
 .\" Source: NVMe
 .\" Language: English
 .\"
-.TH "NVME\-ATTACH\-NS" "1" "03/31/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ATTACH\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

diff --git a/Documentation/nvme-attach-ns.html b/Documentation/nvme-attach-ns.html
@@ -817,7 +817,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-03-31 16:17:28 CEST
+ 2023-06-30 15:20:22 CEST
 </div>
 </div>
 </body>

diff --git a/Documentation/nvme-boot-part-log.1 b/Documentation/nvme-boot-part-log.1
@@ -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: 03/31/2023
+.\" Date: 06/30/2023
 .\" Manual: NVMe Manual
 .\" Source: NVMe
 .\" Language: English
 .\"
-.TH "NVME\-BOOT\-PART\-LO" "1" "03/31/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-BOOT\-PART\-LO" "1" "06/30/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

diff --git a/Documentation/nvme-boot-part-log.html b/Documentation/nvme-boot-part-log.html
@@ -835,7 +835,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-03-31 16:17:28 CEST
+ 2023-06-30 15:20:22 CEST
 </div>
 </div>
 </body>

diff --git a/Documentation/nvme-capacity-mgmt.1 b/Documentation/nvme-capacity-mgmt.1
@@ -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: 03/31/2023
+.\" Date: 06/30/2023
 .\" Manual: NVMe Manual
 .\" Source: NVMe
 .\" Language: English
 .\"
-.TH "NVME\-CAPACITY\-MGMT" "1" "03/31/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CAPACITY\-MGMT" "1" "06/30/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

diff --git a/Documentation/nvme-capacity-mgmt.html b/Documentation/nvme-capacity-mgmt.html
@@ -839,7 +839,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-03-31 16:17:28 CEST
+ 2023-06-30 15:20:22 CEST
 </div>
 </div>
 </body>

diff --git a/Documentation/nvme-changed-ns-list-log.1 b/Documentation/nvme-changed-ns-list-log.1
@@ -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: 03/31/2023
+.\" Date: 06/30/2023
 .\" Manual: NVMe Manual
 .\" Source: NVMe
 .\" Language: English
 .\"
-.TH "NVME\-CHANGED\-NS\-L" "1" "03/31/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CHANGED\-NS\-L" "1" "06/30/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

diff --git a/Documentation/nvme-changed-ns-list-log.html b/Documentation/nvme-changed-ns-list-log.html
@@ -835,7 +835,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-03-31 16:17:28 CEST
+ 2023-06-30 15:20:22 CEST
 </div>
 </div>
 </body>

diff --git a/Documentation/nvme-cmdset-ind-id-ns.1 b/Documentation/nvme-cmdset-ind-id-ns.1
@@ -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: 03/31/2023
+.\" Date: 06/30/2023
 .\" Manual: NVMe Manual
 .\" Source: NVMe
 .\" Language: English
 .\"
-.TH "NVME\-CMDSET\-IND\-I" "1" "03/31/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CMDSET\-IND\-I" "1" "06/30/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

diff --git a/Documentation/nvme-cmdset-ind-id-ns.html b/Documentation/nvme-cmdset-ind-id-ns.html
@@ -879,7 +879,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-03-31 16:17:28 CEST
+ 2023-06-30 15:20:22 CEST
 </div>
 </div>
 </body>

diff --git a/Documentation/nvme-compare.1 b/Documentation/nvme-compare.1
@@ -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: 03/31/2023
+.\" Date: 06/30/2023
 .\" Manual: NVMe Manual
 .\" Source: NVMe
 .\" Language: English
 .\"
-.TH "NVME\-COMPARE" "1" "03/31/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-COMPARE" "1" "06/30/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

diff --git a/Documentation/nvme-compare.html b/Documentation/nvme-compare.html
@@ -1095,7 +1095,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-03-31 16:17:28 CEST
+ 2023-06-30 15:20:22 CEST
 </div>
 </div>
 </body>

diff --git a/Documentation/nvme-connect-all.1 b/Documentation/nvme-connect-all.1
@@ -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: 03/31/2023
+.\" Date: 06/30/2023
 .\" Manual: NVMe Manual
 .\" Source: NVMe
 .\" Language: English
 .\"
-.TH "NVME\-CONNECT\-ALL" "1" "03/31/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CONNECT\-ALL" "1" "06/30/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -59,6 +59,10 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
  [\-\-tls ]
  [\-\-quiet | \-S]
  [\-\-dump\-config | \-O]
+ [\-\-nbft]
+ [\-\-no\-nbft]
+ [\-\-nbft\-path=<STR>]
+ [\-\-context=<STR>]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -242,6 +246,26 @@ Suppress error messages\&.
 .RS 4
 Print out resulting JSON configuration file to stdout\&.
 .RE
+.PP
+\-\-nbft
+.RS 4
+Only look at NBFT tables
+.RE
+.PP
+\-\-no\-nbft
+.RS 4
+Do not look at NBFT tables
+.RE
+.PP
+\-\-nbft\-path=<STR>
+.RS 4
+Use a user\-defined path to the NBFT tables
+.RE
+.PP
+\-\-context <STR>
+.RS 4
+Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&.
+.RE
 .SH "EXAMPLES"
 .sp
 .RS 4
@@ -276,6 +300,52 @@ Connect to all records returned by the Discover Controller with IP4 address 192\
 .\}
 Issue a
 \fInvme connect\-all\fR
+command using the default system defined NBFT tables:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme connect\-all \-\-nbft
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Issue a
+\fInvme connect\-all\fR
+command with a user\-defined path for the NBFT table:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme connet\-all \-\-nbft\-path=/sys/firmware/acpi/tables/NBFT1
+.fi
+.if n \{\
+.RE
+.\}
+.RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Issue a
+\fInvme connect\-all\fR
 command using a /usr/local/etc/nvme/discovery\&.conf file:
 .sp
 .if n \{\