Skip to content

Commit 2264a20

Browse files
committed
doc: Regenerate all docs for v3.0-a.4
Signed-off-by: Daniel Wagner <[email protected]>
1 parent 3af856b commit 2264a20

1,899 files changed

Lines changed: 71203 additions & 30278 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Documentation/nvme-admin-passthru.1

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: nvme-admin-passthru
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 03/11/2026
5+
.\" Date: 04/17/2026
66
.\" Manual: NVMe Manual
77
.\" Source: NVMe
88
.\" Language: English
99
.\"
10-
.TH "NVME\-ADMIN\-PASSTHR" "1" "03/11/2026" "NVMe" "NVMe Manual"
10+
.TH "NVME\-ADMIN\-PASSTHR" "1" "04/17/2026" "NVMe" "NVMe Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -43,13 +43,12 @@ nvme-admin-passthru \- Submit an arbitrary admin command, return results
4343
[\-\-metadata\-len=<len> | \-m <len>]
4444
[\-\-input\-file=<file> | \-i <file>]
4545
[\-\-read | \-r] [\-\-write | \-w]
46-
[\-\-timeout=<timeout>]
4746
[\-\-show\-command | \-s]
4847
[\-\-dry\-run | \-d]
4948
[\-\-raw\-binary | \-b]
5049
[\-\-prefill=<prefill> | \-p <prefill>]
5150
[\-\-latency | \-T]
52-
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
51+
[<global\-options>]
5352
.fi
5453
.SH "DESCRIPTION"
5554
.sp
@@ -132,24 +131,50 @@ Prefill the buffer with a predetermined byte value\&. Defaults to 0\&. This may
132131
.RS 4
133132
Print out the latency the IOCTL took (in us)\&.
134133
.RE
134+
.SH "GLOBAL OPTIONS"
135+
.sp
136+
The following options are defined at the top\-level nvme command and are available to this subcommand:
137+
.PP
138+
\-\-dry\-run
139+
.RS 4
140+
Print the command that would be executed, but do not actually execute it\&.
141+
.RE
142+
.PP
143+
\-\-no\-ioctl\-probing
144+
.RS 4
145+
Disable probing for 64\-bit IOCTL support\&.
146+
.RE
147+
.PP
148+
\-\-no\-retries
149+
.RS 4
150+
Disable retry logic on transient errors\&.
151+
.RE
135152
.PP
136153
\-o <fmt>, \-\-output\-format=<fmt>
137154
.RS 4
138155
Set the reporting format to
139156
\fInormal\fR,
140-
\fIjson\fR
141-
or
142-
\fIbinary\fR\&. Only one output format can be used at a time\&.
157+
\fItabular, \*(Aqjson\fR, or
158+
\fIbinary\fR\&. Only one output format may be used at a time\&.
143159
.RE
144160
.PP
145-
\-v, \-\-verbose
161+
\-\-output\-format\-version=<version>
146162
.RS 4
147-
Increase the information detail in the output\&.
163+
Select the output format version\&. Version
164+
\fI1\fR
165+
uses the original field naming, while version
166+
\fI2\fR
167+
(default) provides more consistent and script\-friendly field names\&.
148168
.RE
149169
.PP
150-
\-\-timeout=<timeout>
170+
\-\-timeout=<ms>
171+
.RS 4
172+
Set the timeout for the command in milliseconds\&.
173+
.RE
174+
.PP
175+
\-v, \-\-verbose
151176
.RS 4
152-
Override default timeout value\&. In milliseconds\&.
177+
Increase the level of detail in the output\&. May be specified multiple times to further increase verbosity\&.
153178
.RE
154179
.SH "EXAMPLES"
155180
.sp

Documentation/nvme-admin-passthru.html

Lines changed: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -760,13 +760,12 @@ <h2 id="_synopsis">SYNOPSIS</h2>
760760
[--metadata-len=&lt;len&gt; | -m &lt;len&gt;]
761761
[--input-file=&lt;file&gt; | -i &lt;file&gt;]
762762
[--read | -r] [--write | -w]
763-
[--timeout=&lt;timeout&gt;]
764763
[--show-command | -s]
765764
[--dry-run | -d]
766765
[--raw-binary | -b]
767766
[--prefill=&lt;prefill&gt; | -p &lt;prefill&gt;]
768767
[--latency | -T]
769-
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
768+
[&lt;global-options&gt;]</pre>
770769
<div class="attribution">
771770
</div></div>
772771
</div>
@@ -963,6 +962,40 @@ <h2 id="_options">OPTIONS</h2>
963962
Print out the latency the IOCTL took (in us).
964963
</p>
965964
</dd>
965+
</dl></div>
966+
</div>
967+
</div>
968+
<div class="sect1">
969+
<h2 id="_global_options">GLOBAL OPTIONS</h2>
970+
<div class="sectionbody">
971+
<div class="paragraph"><p>The following options are defined at the top-level <code>nvme</code> command
972+
and are available to this subcommand:</p></div>
973+
<div class="dlist"><dl>
974+
<dt class="hdlist1">
975+
--dry-run
976+
</dt>
977+
<dd>
978+
<p>
979+
Print the command that would be executed, but do not actually
980+
execute it.
981+
</p>
982+
</dd>
983+
<dt class="hdlist1">
984+
--no-ioctl-probing
985+
</dt>
986+
<dd>
987+
<p>
988+
Disable probing for 64-bit IOCTL support.
989+
</p>
990+
</dd>
991+
<dt class="hdlist1">
992+
--no-retries
993+
</dt>
994+
<dd>
995+
<p>
996+
Disable retry logic on transient errors.
997+
</p>
998+
</dd>
966999
<dt class="hdlist1">
9671000
-o &lt;fmt&gt;
9681001
</dt>
@@ -971,27 +1004,38 @@ <h2 id="_options">OPTIONS</h2>
9711004
</dt>
9721005
<dd>
9731006
<p>
974-
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
975-
output format can be used at a time.
1007+
Set the reporting format to <em>normal</em>, <em>tabular, 'json</em>, or <em>binary</em>.
1008+
Only one output format may be used at a time.
9761009
</p>
9771010
</dd>
9781011
<dt class="hdlist1">
979-
-v
1012+
--output-format-version=&lt;version&gt;
9801013
</dt>
1014+
<dd>
1015+
<p>
1016+
Select the output format version. Version <em>1</em> uses the original
1017+
field naming, while version <em>2</em> (default) provides more consistent
1018+
and script-friendly field names.
1019+
</p>
1020+
</dd>
9811021
<dt class="hdlist1">
982-
--verbose
1022+
--timeout=&lt;ms&gt;
9831023
</dt>
9841024
<dd>
9851025
<p>
986-
Increase the information detail in the output.
1026+
Set the timeout for the command in milliseconds.
9871027
</p>
9881028
</dd>
9891029
<dt class="hdlist1">
990-
--timeout=&lt;timeout&gt;
1030+
-v
1031+
</dt>
1032+
<dt class="hdlist1">
1033+
--verbose
9911034
</dt>
9921035
<dd>
9931036
<p>
994-
Override default timeout value. In milliseconds.
1037+
Increase the level of detail in the output. May be specified
1038+
multiple times to further increase verbosity.
9951039
</p>
9961040
</dd>
9971041
</dl></div>
@@ -1036,7 +1080,7 @@ <h2 id="_nvme">NVME</h2>
10361080
<div id="footer">
10371081
<div id="footer-text">
10381082
Last updated
1039-
2026-03-11 17:34:17 CET
1083+
2026-04-17 09:23:05 CEST
10401084
</div>
10411085
</div>
10421086
</body>

Documentation/nvme-ana-log.1

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: nvme-ana-log
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 03/11/2026
5+
.\" Date: 04/17/2026
66
.\" Manual: NVMe Manual
77
.\" Source: NVMe
88
.\" Language: English
99
.\"
10-
.TH "NVME\-ANA\-LOG" "1" "03/11/2026" "NVMe" "NVMe Manual"
10+
.TH "NVME\-ANA\-LOG" "1" "04/17/2026" "NVMe" "NVMe Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -33,7 +33,7 @@ nvme-ana-log \- Send NVMe ANA log page request, returns result and log
3333
.sp
3434
.nf
3535
\fInvme ana\-log\fR <device> [\-\-groups | \-g]
36-
[\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
36+
[<global\-options>]
3737
.fi
3838
.SH "DESCRIPTION"
3939
.sp
@@ -48,19 +48,50 @@ On success, the returned ANA log structure may be returned in one of several way
4848
.RS 4
4949
Return the list of ANA groups without the namespace listing\&.
5050
.RE
51+
.SH "GLOBAL OPTIONS"
52+
.sp
53+
The following options are defined at the top\-level nvme command and are available to this subcommand:
54+
.PP
55+
\-\-dry\-run
56+
.RS 4
57+
Print the command that would be executed, but do not actually execute it\&.
58+
.RE
59+
.PP
60+
\-\-no\-ioctl\-probing
61+
.RS 4
62+
Disable probing for 64\-bit IOCTL support\&.
63+
.RE
64+
.PP
65+
\-\-no\-retries
66+
.RS 4
67+
Disable retry logic on transient errors\&.
68+
.RE
5169
.PP
5270
\-o <fmt>, \-\-output\-format=<fmt>
5371
.RS 4
5472
Set the reporting format to
5573
\fInormal\fR,
56-
\fIjson\fR
57-
or
58-
\fIbinary\fR\&. Only one output format can be used at a time\&.
74+
\fItabular, \*(Aqjson\fR, or
75+
\fIbinary\fR\&. Only one output format may be used at a time\&.
76+
.RE
77+
.PP
78+
\-\-output\-format\-version=<version>
79+
.RS 4
80+
Select the output format version\&. Version
81+
\fI1\fR
82+
uses the original field naming, while version
83+
\fI2\fR
84+
(default) provides more consistent and script\-friendly field names\&.
85+
.RE
86+
.PP
87+
\-\-timeout=<ms>
88+
.RS 4
89+
Set the timeout for the command in milliseconds\&.
5990
.RE
6091
.PP
6192
\-v, \-\-verbose
6293
.RS 4
63-
Increase the information detail in the output\&.
94+
Increase the level of detail in the output\&. May be specified multiple times to further increase verbosity\&.
6495
.RE
6596
.SH "EXAMPLES"
6697
.sp

Documentation/nvme-ana-log.html

Lines changed: 58 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -750,7 +750,7 @@ <h2 id="_synopsis">SYNOPSIS</h2>
750750
<div class="sectionbody">
751751
<div class="verseblock">
752752
<pre class="content"><em>nvme ana-log</em> &lt;device&gt; [--groups | -g]
753-
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;] [--verbose | -v]</pre>
753+
[&lt;global-options&gt;]</pre>
754754
<div class="attribution">
755755
</div></div>
756756
</div>
@@ -782,6 +782,40 @@ <h2 id="_options">OPTIONS</h2>
782782
Return the list of ANA groups without the namespace listing.
783783
</p>
784784
</dd>
785+
</dl></div>
786+
</div>
787+
</div>
788+
<div class="sect1">
789+
<h2 id="_global_options">GLOBAL OPTIONS</h2>
790+
<div class="sectionbody">
791+
<div class="paragraph"><p>The following options are defined at the top-level <code>nvme</code> command
792+
and are available to this subcommand:</p></div>
793+
<div class="dlist"><dl>
794+
<dt class="hdlist1">
795+
--dry-run
796+
</dt>
797+
<dd>
798+
<p>
799+
Print the command that would be executed, but do not actually
800+
execute it.
801+
</p>
802+
</dd>
803+
<dt class="hdlist1">
804+
--no-ioctl-probing
805+
</dt>
806+
<dd>
807+
<p>
808+
Disable probing for 64-bit IOCTL support.
809+
</p>
810+
</dd>
811+
<dt class="hdlist1">
812+
--no-retries
813+
</dt>
814+
<dd>
815+
<p>
816+
Disable retry logic on transient errors.
817+
</p>
818+
</dd>
785819
<dt class="hdlist1">
786820
-o &lt;fmt&gt;
787821
</dt>
@@ -790,8 +824,26 @@ <h2 id="_options">OPTIONS</h2>
790824
</dt>
791825
<dd>
792826
<p>
793-
Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one
794-
output format can be used at a time.
827+
Set the reporting format to <em>normal</em>, <em>tabular, 'json</em>, or <em>binary</em>.
828+
Only one output format may be used at a time.
829+
</p>
830+
</dd>
831+
<dt class="hdlist1">
832+
--output-format-version=&lt;version&gt;
833+
</dt>
834+
<dd>
835+
<p>
836+
Select the output format version. Version <em>1</em> uses the original
837+
field naming, while version <em>2</em> (default) provides more consistent
838+
and script-friendly field names.
839+
</p>
840+
</dd>
841+
<dt class="hdlist1">
842+
--timeout=&lt;ms&gt;
843+
</dt>
844+
<dd>
845+
<p>
846+
Set the timeout for the command in milliseconds.
795847
</p>
796848
</dd>
797849
<dt class="hdlist1">
@@ -802,7 +854,8 @@ <h2 id="_options">OPTIONS</h2>
802854
</dt>
803855
<dd>
804856
<p>
805-
Increase the information detail in the output.
857+
Increase the level of detail in the output. May be specified
858+
multiple times to further increase verbosity.
806859
</p>
807860
</dd>
808861
</dl></div>
@@ -835,7 +888,7 @@ <h2 id="_nvme">NVME</h2>
835888
<div id="footer">
836889
<div id="footer-text">
837890
Last updated
838-
2026-03-11 17:34:17 CET
891+
2026-04-17 09:23:05 CEST
839892
</div>
840893
</div>
841894
</body>

0 commit comments

Comments
 (0)