doc: Regenerate all docs for v2.7

Signed-off-by: Daniel Wagner <dwagner@suse.de>
linux-nvme · Dec 19, 2023 · 807a66c · 807a66c
1 parent 83e37d4
commit 807a66c
Show file tree

Hide file tree

Showing 380 changed files with 4,939 additions and 2,479 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: 06/30/2023
+.\"      Date: 12/19/2023
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ADMIN\-PASSTHR" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ADMIN\-PASSTHR" "1" "12/19/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -32,23 +32,24 @@ nvme-admin-passthru \- Submit an arbitrary admin command, return results
 .SH "SYNOPSIS"
 .sp
 .nf
-\fInvme\-admin\-passthru\fR <device> [\-\-opcode=<opcode> | \-o <opcode>]
-                [\-\-flags=<flags> | \-f <flags>] [\-rsvd=<rsvd> | \-R <rsvd>]
-                [\-\-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>]
-                [\-\-read | \-r ] [\-\-write | \-w]
-                [\-\-timeout=<to> | \-t <to>]
-                [\-\-show\-command | \-s]
-                [\-\-dry\-run | \-d]
-                [\-\-raw\-binary | \-b]
-                [\-\-prefill=<prefill> | \-p <prefill>]
-                [\-\-latency | \-T]
+\fInvme\-admin\-passthru\fR <device> [\-\-opcode=<opcode> | \-O <opcode>]
+                        [\-\-flags=<flags> | \-f <flags>] [\-rsvd=<rsvd> | \-R <rsvd>]
+                        [\-\-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>]
+                        [\-\-read | \-r] [\-\-write | \-w]
+                        [\-\-timeout=<to> | \-t <to>]
+                        [\-\-show\-command | \-s]
+                        [\-\-dry\-run | \-d]
+                        [\-\-raw\-binary | \-b]
+                        [\-\-prefill=<prefill> | \-p <prefill>]
+                        [\-\-latency | \-T]
+                        [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -59,7 +60,7 @@ The <device> parameter is mandatory and may be either the NVMe character device
 On success, the returned structure (if applicable) may be returned in one of several ways depending on the option flags; the structure may printed by the program as a hex dump, or may be returned as a raw buffer printed to stdout for another program to parse\&.
 .SH "OPTIONS"
 .PP
-\-o <opcode>, \-\-opcode=<opcode>
+\-O <opcode>, \-\-opcode=<opcode>
 .RS 4
 The NVMe opcode to send to the device in the command
 .RE
@@ -131,6 +132,20 @@ Prefill the buffer with a predetermined byte value\&. Defaults to 0\&. This may
 .RS 4
 Print out the latency the IOCTL took (in us)\&.
 .RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
 .SH "EXAMPLES"
 .sp
 .RS 4

diff --git a/Documentation/nvme-admin-passthru.html b/Documentation/nvme-admin-passthru.html
@@ -749,23 +749,24 @@ <h2>NAME</h2>
 <h2 id="_synopsis">SYNOPSIS</h2>
 <div class="sectionbody">
 <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; | -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;]
-                [--read | -r ] [--write | -w]
-                [--timeout=&lt;to&gt; | -t &lt;to&gt;]
-                [--show-command | -s]
-                [--dry-run | -d]
-                [--raw-binary | -b]
-                [--prefill=&lt;prefill&gt; | -p &lt;prefill&gt;]
-                [--latency | -T]</pre>
+<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; | -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;]
+                        [--read | -r] [--write | -w]
+                        [--timeout=&lt;to&gt; | -t &lt;to&gt;]
+                        [--show-command | -s]
+                        [--dry-run | -d]
+                        [--raw-binary | -b]
+                        [--prefill=&lt;prefill&gt; | -p &lt;prefill&gt;]
+                        [--latency | -T]
+                        [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
 <div class="attribution">
 </div></div>
 </div>
@@ -790,7 +791,7 @@ <h2 id="_options">OPTIONS</h2>
 <div class="sectionbody">
 <div class="dlist"><dl>
 <dt class="hdlist1">
--o &lt;opcode&gt;
+-O &lt;opcode&gt;
 </dt>
 <dt class="hdlist1">
 --opcode=&lt;opcode&gt;
@@ -961,6 +962,29 @@ <h2 id="_options">OPTIONS</h2>
         Print out the latency the IOCTL took (in us).
 </p>
 </dd>
+<dt class="hdlist1">
+-o &lt;fmt&gt;
+</dt>
+<dt class="hdlist1">
+--output-format=&lt;fmt&gt;
+</dt>
+<dd>
+<p>
+        Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+        output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+        Increase the information detail in the output.
+</p>
+</dd>
 </dl></div>
 </div>
 </div>
@@ -1003,7 +1027,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-09-29 08:33:07 CEST
+ 2023-12-19 12:48:29 CET
 </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: 06/30/2023
+.\"      Date: 12/19/2023
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ANA\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ANA\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -32,7 +32,8 @@ nvme-ana-log \- Send NVMe ANA log page request, returns result and log
 .SH "SYNOPSIS"
 .sp
 .nf
-\fInvme ana\-log\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme ana\-log\fR <device> [\-\-groups | \-g]
+                        [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -48,13 +49,19 @@ On success, the returned ANA log structure may be returned in one of several way
 Return the list of ANA groups without the namespace listing\&.
 .RE
 .PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
 .RS 4
 Set the reporting format to
 \fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
 \fIbinary\fR\&. Only one output format can be used at a time\&.
 .RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
 .SH "EXAMPLES"
 .sp
 .RS 4

diff --git a/Documentation/nvme-ana-log.html b/Documentation/nvme-ana-log.html
@@ -749,7 +749,8 @@ <h2>NAME</h2>
 <h2 id="_synopsis">SYNOPSIS</h2>
 <div class="sectionbody">
 <div class="verseblock">
-<pre class="content"><em>nvme ana-log</em> &lt;device&gt; [-o &lt;fmt&gt; | --output-format=&lt;fmt&gt;]</pre>
+<pre class="content"><em>nvme ana-log</em> &lt;device&gt; [--groups | -g]
+                        [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
 <div class="attribution">
 </div></div>
 </div>
@@ -778,19 +779,30 @@ <h2 id="_options">OPTIONS</h2>
 </dt>
 <dd>
 <p>
-              Return the list of ANA groups without the namespace listing.
+        Return the list of ANA groups without the namespace listing.
 </p>
 </dd>
 <dt class="hdlist1">
--o &lt;format&gt;
+-o &lt;fmt&gt;
 </dt>
 <dt class="hdlist1">
---output-format=&lt;format&gt;
+--output-format=&lt;fmt&gt;
 </dt>
 <dd>
 <p>
-              Set the reporting format to <em>normal</em>, <em>json</em>, or
-              <em>binary</em>. Only one output format can be used at a time.
+        Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+        output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+        Increase the information detail in the output.
 </p>
 </dd>
 </dl></div>
@@ -823,7 +835,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-09-29 08:33:07 CEST
+ 2023-12-19 12:48:29 CET
 </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: 06/30/2023
+.\"      Date: 12/19/2023
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ATTACH\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ATTACH\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -34,6 +34,7 @@ nvme-attach-ns \- Send NVMe attach namespace, return result\&.
 .nf
 \fInvme attach\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
                         [\-\-controllers=<ctrl\-list,> | \-c <ctrl\-list,>]
+                        [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -49,6 +50,20 @@ The namespace identifier to attach\&.
 .RS 4
 The comma separated list of controller identifiers to attach the namespace too\&.
 .RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
 .SH "EXAMPLES"
 .sp
 .if n \{\
@@ -65,7 +80,7 @@ Attach namespace to the controller:
 .RS 4
 .\}
 .nf
-# nvme attach\-ns /dev/nvme1  \-n 0x2 \-c 0x21
+# nvme attach\-ns /dev/nvme1 \-n 0x2 \-c 0x21
 .fi
 .if n \{\
 .RE

diff --git a/Documentation/nvme-attach-ns.html b/Documentation/nvme-attach-ns.html
@@ -750,7 +750,8 @@ <h2 id="_synopsis">SYNOPSIS</h2>
 <div class="sectionbody">
 <div class="verseblock">
 <pre class="content"><em>nvme attach-ns</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
-                        [--controllers=&lt;ctrl-list,&gt; | -c &lt;ctrl-list,&gt;]</pre>
+                        [--controllers=&lt;ctrl-list,&gt; | -c &lt;ctrl-list,&gt;]
+                        [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
 <div class="attribution">
 </div></div>
 </div>
@@ -790,6 +791,29 @@ <h2 id="_options">OPTIONS</h2>
         the namespace too.
 </p>
 </dd>
+<dt class="hdlist1">
+-o &lt;fmt&gt;
+</dt>
+<dt class="hdlist1">
+--output-format=&lt;fmt&gt;
+</dt>
+<dd>
+<p>
+        Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
+        output format can be used at a time.
+</p>
+</dd>
+<dt class="hdlist1">
+-v
+</dt>
+<dt class="hdlist1">
+--verbose
+</dt>
+<dd>
+<p>
+        Increase the information detail in the output.
+</p>
+</dd>
 </dl></div>
 </div>
 </div>
@@ -802,7 +826,7 @@ <h2 id="_examples">EXAMPLES</h2>
 </div></div>
 <div class="literalblock">
 <div class="content">
-<pre><code># nvme attach-ns /dev/nvme1  -n 0x2 -c 0x21</code></pre>
+<pre><code># nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21</code></pre>
 </div></div>
 </div>
 </div>
@@ -817,7 +841,7 @@ <h2 id="_nvme">NVME</h2>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2023-09-29 08:33:07 CEST
+ 2023-12-19 12:48:29 CET
 </div>
 </div>
 </body>