Skip to content

Commit 87b4643

Browse files
igawigaw
committed
docs: move global/fabrics options into separate files
Reduce the huge documentation duplication of the common global and fabrics options by moving them into separate files and include them. Used the magic regex engine called Copilot for modifying all files. Signed-off-by: Daniel Wagner <[email protected]>
1 parent ba30d1e commit 87b4643

299 files changed

Lines changed: 1162 additions & 2428 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/fabrics-options.txt‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
FABRICS OPTIONS
2+
---------------
3+
4+
The following options are common to NVMe over Fabrics commands such as
5+
`nvme connect`:
6+
7+
-a <traddr>::
8+
--traddr=<traddr>::
9+
Specify the network address of the controller. For transports
10+
using IP addressing (e.g. rdma, tcp), this should be an IP address.
11+
12+
--concat::
13+
Enable secure concatenation (TCP).
14+
15+
-c <#>::
16+
--reconnect-delay=<#>::
17+
Set the delay in seconds before reconnect is attempted after a
18+
connection loss.
19+
20+
-C <secret>::
21+
--dhchap-ctrl-secret=<secret>::
22+
Controller authentication secret for bi-directional authentication.
23+
If not specified, bi-directional authentication is not attempted.
24+
25+
-S <secret>::
26+
--dhchap-secret=<secret>::
27+
Host authentication secret (DH-HMAC-CHAP). Must be provided in ASCII
28+
format as defined in the NVMe specification.
29+
30+
--disable-sqflow::
31+
Disable submission queue flow control.
32+
33+
-G::
34+
--data-digest::
35+
Enable data digest generation/verification (TCP).
36+
37+
-D::
38+
--duplicate-connect::
39+
Allow duplicate connections to the same subsystem.
40+
41+
-g::
42+
--hdr-digest::
43+
Enable header digest generation/verification (TCP).
44+
45+
-f <iface>::
46+
--host-iface=<iface>::
47+
Specify the network interface to use for the connection.
48+
49+
-I <hostid>::
50+
--hostid=<hostid>::
51+
Specify the host UUID.
52+
53+
-q <hostnqn>::
54+
--hostnqn=<hostnqn>::
55+
Override the default host NQN.
56+
57+
-w <traddr>::
58+
--host-traddr=<traddr>::
59+
Specify the source address on the host side of the connection.
60+
61+
-k <#>::
62+
--keep-alive-tmo=<#>::
63+
Set the keep-alive timeout in seconds.
64+
65+
--keyring=<keyring>::
66+
Keyring to use for TLS key lookup.
67+
68+
-n <subnqn>::
69+
--nqn=<subnqn>::
70+
Specify the NVMe subsystem NQN to connect to.
71+
72+
-i <#>::
73+
--nr-io-queues=<#>::
74+
Number of I/O queues to create.
75+
76+
-P <#>::
77+
--nr-poll-queues=<#>::
78+
Number of polling queues to create.
79+
80+
-W <#>::
81+
--nr-write-queues=<#>::
82+
Number of write queues to create.
83+
84+
-Q <#>::
85+
--queue-size=<#>::
86+
Queue depth for I/O queues.
87+
88+
-l <#>::
89+
--ctrl-loss-tmo=<#>::
90+
Maximum time in seconds to retry reconnect attempts after
91+
controller loss.
92+
93+
-s <trsvcid>::
94+
--trsvcid=<trsvcid>::
95+
Transport service identifier (e.g. TCP/rdma port). Default is 4420
96+
for RDMA.
97+
98+
-T <#>::
99+
--tos=<#>::
100+
Type of service value for the connection (TCP).
101+
102+
-t <trtype>::
103+
--transport=<trtype>::
104+
Specify the transport type. Supported values include:
105+
106+
+
107+
[]
108+
|=================
109+
|Value | Description
110+
|rdma | RDMA (RoCE, iWARP, InfiniBand)
111+
|tcp | TCP/IP
112+
|fc | Fibre Channel (*experimental*)
113+
|loop | Local loopback transport
114+
|=================
115+
116+
--tls::
117+
Enable TLS encryption (TCP).
118+
119+
--tls-key=<tls-key>::
120+
TLS key for the connection. It is recommended to preload keys
121+
into the system keyring instead of passing them via the command line.
122+
123+
--tls-key-identity=<identity>::
124+
Identity associated with the TLS key.
125+

‎Documentation/global-options.txt‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
GLOBAL OPTIONS
2+
--------------
3+
4+
The following options are defined at the top-level `nvme` command
5+
and are available to this subcommand:
6+
7+
--dry-run::
8+
Print the command that would be executed, but do not actually
9+
execute it.
10+
11+
--no-ioctl-probing::
12+
Disable probing for 64-bit IOCTL support.
13+
14+
--no-retries::
15+
Disable retry logic on transient errors.
16+
17+
-o <fmt>::
18+
--output-format=<fmt>::
19+
Set the reporting format to 'normal', 'tabular, 'json', or 'binary'.
20+
Only one output format may be used at a time.
21+
22+
--output-format-version=<version>::
23+
Select the output format version. Version '1' uses the original
24+
field naming, while version '2' (default) provides more consistent
25+
and script-friendly field names.
26+
27+
--timeout=<ms>::
28+
Set the timeout for the command in milliseconds.
29+
30+
-v::
31+
--verbose::
32+
Increase the level of detail in the output. May be specified
33+
multiple times to further increase verbosity.

‎Documentation/meson.build‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -265,6 +265,8 @@ adoc_sources = [
265265
adoc_includes = [
266266
'cmd-plugins.txt',
267267
'cmds-main.txt',
268+
'global-options.txt',
269+
'fabrics-options.txt',
268270
]
269271

270272
if want_docs != 'false'

‎Documentation/nvme-admin-passthru.txt‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ SYNOPSIS
1919
[--metadata-len=<len> | -m <len>]
2020
[--input-file=<file> | -i <file>]
2121
[--read | -r] [--write | -w]
22-
[--timeout=<timeout>]
2322
[--show-command | -s]
2423
[--dry-run | -d]
2524
[--raw-binary | -b]
2625
[--prefill=<prefill> | -p <prefill>]
2726
[--latency | -T]
28-
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
27+
[<global-options>]
2928

3029
DESCRIPTION
3130
-----------
@@ -115,17 +114,7 @@ OPTIONS
115114
--latency::
116115
Print out the latency the IOCTL took (in us).
117116

118-
-o <fmt>::
119-
--output-format=<fmt>::
120-
Set the reporting format to 'normal', 'json' or 'binary'. Only one
121-
output format can be used at a time.
122-
123-
-v::
124-
--verbose::
125-
Increase the information detail in the output.
126-
127-
--timeout=<timeout>::
128-
Override default timeout value. In milliseconds.
117+
include::global-options.txt[]
129118

130119
EXAMPLES
131120
--------

‎Documentation/nvme-ana-log.txt‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ SYNOPSIS
99
--------
1010
[verse]
1111
'nvme ana-log' <device> [--groups | -g]
12-
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
12+
[<global-options>]
1313

1414
DESCRIPTION
1515
-----------
@@ -29,14 +29,7 @@ OPTIONS
2929
--groups::
3030
Return the list of ANA groups without the namespace listing.
3131

32-
-o <fmt>::
33-
--output-format=<fmt>::
34-
Set the reporting format to 'normal', 'json' or 'binary'. Only one
35-
output format can be used at a time.
36-
37-
-v::
38-
--verbose::
39-
Increase the information detail in the output.
32+
include::global-options.txt[]
4033

4134
EXAMPLES
4235
--------

‎Documentation/nvme-attach-ns.txt‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ SYNOPSIS
1010
[verse]
1111
'nvme attach-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
1212
[--controllers=<ctrl-list,> | -c <ctrl-list,>]
13-
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
13+
[<global-options>]
1414

1515
DESCRIPTION
1616
-----------
@@ -33,14 +33,7 @@ OPTIONS
3333
namespace too. If no list is provided, the namespace will be attached
3434
to the <device> controller used for this command.
3535

36-
-o <fmt>::
37-
--output-format=<fmt>::
38-
Set the reporting format to 'normal', 'json' or 'binary'. Only one
39-
output format can be used at a time.
40-
41-
-v::
42-
--verbose::
43-
Increase the information detail in the output.
36+
include::global-options.txt[]
4437

4538
EXAMPLES
4639
--------

‎Documentation/nvme-ave-discovery-log.txt‎

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ nvme-ave-discovery-log - Retrieve AVE Discovery Log, show it
88
SYNOPSIS
99
--------
1010
[verse]
11-
'nvme ave-discovery-log' <device> [--rae | -r] [--verbose | -v]
12-
[--output-format=<fmt> | -o <fmt>] [--timeout=<timeout>]
11+
'nvme ave-discovery-log' <device> [--rae | -r]
12+
[<global-options>]
1313

1414
DESCRIPTION
1515
-----------
@@ -25,17 +25,7 @@ OPTIONS
2525
--rae::
2626
Retain an Asynchronous Event.
2727

28-
-v::
29-
--verbose::
30-
Increase the information detail in the output.
31-
32-
-o <fmt>::
33-
--output-format=<fmt>::
34-
Set the reporting format to 'normal', 'json' or 'binary'. Only one
35-
output format can be used at a time.
36-
37-
--timeout=<timeout>::
38-
Override default timeout value. In milliseconds.
28+
include::global-options.txt[]
3929

4030
EXAMPLES
4131
--------

‎Documentation/nvme-boot-part-log.txt‎

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ SYNOPSIS
1010
[verse]
1111
'nvme boot-part-log' <device> [--lsp=<field> | -s <field>]
1212
[--output-file=<file> | -f <file>]
13-
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
13+
[<global-options>]
1414

1515
DESCRIPTION
1616
-----------
@@ -33,14 +33,7 @@ OPTIONS
3333
--output-file=<file>::
3434
File name to which raw binary data will be saved to.
3535

36-
-o <fmt>::
37-
--output-format=<fmt>::
38-
Set the reporting format to 'normal', 'json' or 'binary'. Only one
39-
output format can be used at a time.
40-
41-
-v::
42-
--verbose::
43-
Increase the information detail in the output.
36+
include::global-options.txt[]
4437

4538
EXAMPLES
4639
--------

‎Documentation/nvme-capacity-mgmt.txt‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ SYNOPSIS
1313
[--element-id=<element-id> | -i <element-id>]
1414
[--cap-lower=<cap-lower> | -l <cap-lower>]
1515
[--cap-upper=<cap-upper> | -u <cap-upper>]
16-
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
17-
[--timeout=<timeout>]
16+
[<global-options>]
1817

1918
DESCRIPTION
2019
-----------
@@ -47,17 +46,7 @@ OPTIONS
4746
Most significant 32 bits of the capacity in bytes of the Endurance Group or
4847
NVM Set to be created
4948

50-
-o <fmt>::
51-
--output-format=<fmt>::
52-
Set the reporting format to 'normal', 'json' or 'binary'. Only one
53-
output format can be used at a time.
54-
55-
-v::
56-
--verbose::
57-
Increase the information detail in the output.
58-
59-
--timeout=<timeout>::
60-
Override default timeout value. In milliseconds.
49+
include::global-options.txt[]
6150

6251
EXAMPLES
6352
--------

‎Documentation/nvme-changed-alloc-ns-list-log.txt‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ SYNOPSIS
1010
--------
1111
[verse]
1212
'nvme changed-alloc-ns-list-log' <device> [--raw-binary | -b]
13-
[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
14-
[--timeout=<timeout>]
13+
[<global-options>]
1514

1615
DESCRIPTION
1716
-----------
@@ -32,17 +31,7 @@ OPTIONS
3231
--raw-binary::
3332
Print the raw Changed Namespace List log buffer to stdout.
3433

35-
-o <fmt>::
36-
--output-format=<fmt>::
37-
Set the reporting format to 'normal', 'json' or 'binary'. Only one
38-
output format can be used at a time.
39-
40-
-v::
41-
--verbose::
42-
Increase the information detail in the output.
43-
44-
--timeout=<timeout>::
45-
Override default timeout value. In milliseconds.
34+
include::global-options.txt[]
4635

4736
EXAMPLES
4837
--------

0 commit comments

Comments
 (0)