docs: move global/fabrics options into separate files

Documentation/fabrics-options.txt

@@ -0,0 +1,124 @@
+FABRICS OPTIONS
+---------------
+
+The following options are common to NVMe over Fabrics commands such as
+`nvme connect`:
+
+-a <traddr>::
+--traddr=<traddr>::
+	Specify the network address of the controller. For transports
+	using IP addressing (e.g. rdma, tcp), this should be an IP address.
+
+--concat::
+	Enable secure concatenation (TCP).
+
+-c <#>::
+--reconnect-delay=<#>::
+	Set the delay in seconds before reconnect is attempted after a
+	connection loss.
+
+-C <secret>::
+--dhchap-ctrl-secret=<secret>::
+	Controller authentication secret for bi-directional authentication.
+	If not specified, bi-directional authentication is not attempted.
+
+-S <secret>::
+--dhchap-secret=<secret>::
+	Host authentication secret (DH-HMAC-CHAP). Must be provided in ASCII
+	format as defined in the NVMe specification.
+
+--disable-sqflow::
+	Disable submission queue flow control.
+
+-G::
+--data-digest::
+	Enable data digest generation/verification (TCP).
+
+-D::
+--duplicate-connect::
+	Allow duplicate connections to the same subsystem.
+
+-g::
+--hdr-digest::
+	Enable header digest generation/verification (TCP).
+
+-f <iface>::
+--host-iface=<iface>::
+	Specify the network interface to use for the connection.
+
+-I <hostid>::
+--hostid=<hostid>::
+	Specify the host UUID.
+
+-q <hostnqn>::
+--hostnqn=<hostnqn>::
+	Override the default host NQN.
+
+-w <traddr>::
+--host-traddr=<traddr>::
+	Specify the source address on the host side of the connection.
+
+-k <#>::
+--keep-alive-tmo=<#>::
+	Set the keep-alive timeout in seconds.
+
+--keyring=<keyring>::
+	Keyring to use for TLS key lookup.
+
+-n <subnqn>::
+--nqn=<subnqn>::
+	Specify the NVMe subsystem NQN to connect to.
+
+-i <#>::
+--nr-io-queues=<#>::
+	Number of I/O queues to create.
+
+-P <#>::
+--nr-poll-queues=<#>::
+	Number of polling queues to create.
+
+-W <#>::
+--nr-write-queues=<#>::
+	Number of write queues to create.
+
+-Q <#>::
+--queue-size=<#>::
+	Queue depth for I/O queues.
+
+-l <#>::
+--ctrl-loss-tmo=<#>::
+	Maximum time in seconds to retry reconnect attempts after
+	controller loss.
+
+-s <trsvcid>::
+--trsvcid=<trsvcid>::
+	Transport service identifier (e.g. TCP/rdma port). Default is 4420
+	for RDMA.
+
+-T <#>::
+--tos=<#>::
+	Type of service value for the connection (TCP).
+
+-t <trtype>::
+--transport=<trtype>::
+	Specify the transport type. Supported values include:
+
++
+[]
+|=================
+|Value | Description
+|rdma  | RDMA (RoCE, iWARP, InfiniBand)
+|tcp   | TCP/IP
+|fc    | Fibre Channel (*experimental*)
+|loop  | Local loopback transport
+|=================
+
+--tls::
+	Enable TLS encryption (TCP).
+
+--tls-key=<tls-key>::
+	TLS key for the connection. It is recommended to preload keys
+	into the system keyring instead of passing them via the command line.
+
+--tls-key-identity=<identity>::
+	Identity associated with the TLS key.

Documentation/global-options.txt

@@ -0,0 +1,33 @@
+GLOBAL OPTIONS
+--------------
+
+The following options are defined at the top-level `nvme` command
+and are available to this subcommand:
+
+--dry-run::
+	Print the command that would be executed, but do not actually
+	execute it.
+
+--no-ioctl-probing::
+	Disable probing for 64-bit IOCTL support.
+
+--no-retries::
+	Disable retry logic on transient errors.
+
+-o <fmt>::
+--output-format=<fmt>::
+	Set the reporting format to 'normal', 'tabular, 'json', or 'binary'.
+	Only one output format may be used at a time.
+
+--output-format-version=<version>::
+	Select the output format version. Version '1' uses the original
+	field naming, while version '2' (default) provides more consistent
+	and script-friendly field names.
+
+--timeout=<ms>::
+	Set the timeout for the command in milliseconds.
+
+-v::
+--verbose::
+	Increase the level of detail in the output. May be specified
+	multiple times to further increase verbosity.

Documentation/meson.build

@@ -265,6 +265,8 @@ adoc_sources = [
 adoc_includes = [
     'cmd-plugins.txt',
     'cmds-main.txt',
+    'global-options.txt',
+    'fabrics-options.txt',
 ]
 
 if want_docs != 'false'

Documentation/nvme-admin-passthru.txt

@@ -19,13 +19,12 @@ SYNOPSIS
 			[--metadata-len=<len> | -m <len>]
 			[--input-file=<file> | -i <file>]
 			[--read | -r] [--write | -w]
-			[--timeout=<timeout>]
 			[--show-command | -s]
 			[--dry-run | -d]
 			[--raw-binary | -b]
 			[--prefill=<prefill> | -p <prefill>]
 			[--latency | -T]
-			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[<global-options>]
 
 DESCRIPTION
 -----------
@@ -115,17 +114,7 @@ OPTIONS
 --latency::
 	Print out the latency the IOCTL took (in us).
 
--o <fmt>::
---output-format=<fmt>::
-	Set the reporting format to 'normal', 'json' or 'binary'. Only one
-	output format can be used at a time.
-
--v::
---verbose::
-	Increase the information detail in the output.
-
---timeout=<timeout>::
-	Override default timeout value. In milliseconds.
+include::global-options.txt[]
 
 EXAMPLES
 --------

Documentation/nvme-ana-log.txt

@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'nvme ana-log' <device> [--groups | -g]
-			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[<global-options>]
 
 DESCRIPTION
 -----------
@@ -29,14 +29,7 @@ OPTIONS
 --groups::
 	Return the list of ANA groups without the namespace listing.
 
--o <fmt>::
---output-format=<fmt>::
-	Set the reporting format to 'normal', 'json' or 'binary'. Only one
-	output format can be used at a time.
-
--v::
---verbose::
-	Increase the information detail in the output.
+include::global-options.txt[]
 
 EXAMPLES
 --------

Documentation/nvme-attach-ns.txt

@@ -10,7 +10,7 @@ SYNOPSIS
 [verse]
 'nvme attach-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
 			[--controllers=<ctrl-list,> | -c <ctrl-list,>]
-			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[<global-options>]
 
 DESCRIPTION
 -----------
@@ -33,14 +33,7 @@ OPTIONS
 	namespace too. If no list is provided, the namespace will be attached
 	to the <device> controller used for this command.
 
--o <fmt>::
---output-format=<fmt>::
-	Set the reporting format to 'normal', 'json' or 'binary'. Only one
-	output format can be used at a time.
-
--v::
---verbose::
-	Increase the information detail in the output.
+include::global-options.txt[]
 
 EXAMPLES
 --------

Documentation/nvme-ave-discovery-log.txt

@@ -8,8 +8,8 @@ nvme-ave-discovery-log - Retrieve AVE Discovery Log, show it
 SYNOPSIS
 --------
 [verse]
-'nvme ave-discovery-log' <device> [--rae | -r] [--verbose | -v]
-			[--output-format=<fmt> | -o <fmt>] [--timeout=<timeout>]
+'nvme ave-discovery-log' <device> [--rae | -r]
+			[<global-options>]
 
 DESCRIPTION
 -----------
@@ -25,17 +25,7 @@ OPTIONS
 --rae::
 	Retain an Asynchronous Event.
 
--v::
---verbose::
-	Increase the information detail in the output.
-
--o <fmt>::
---output-format=<fmt>::
-	Set the reporting format to 'normal', 'json' or 'binary'. Only one
-	output format can be used at a time.
-
---timeout=<timeout>::
-	Override default timeout value. In milliseconds.
+include::global-options.txt[]
 
 EXAMPLES
 --------

Documentation/nvme-boot-part-log.txt

@@ -10,7 +10,7 @@ SYNOPSIS
 [verse]
 'nvme boot-part-log' <device> [--lsp=<field> | -s <field>]
 			[--output-file=<file> | -f <file>]
-			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[<global-options>]
 
 DESCRIPTION
 -----------
@@ -33,14 +33,7 @@ OPTIONS
 --output-file=<file>::
 	File name to which raw binary data will be saved to.
 
--o <fmt>::
---output-format=<fmt>::
-	Set the reporting format to 'normal', 'json' or 'binary'. Only one
-	output format can be used at a time.
-
--v::
---verbose::
-	Increase the information detail in the output.
+include::global-options.txt[]
 
 EXAMPLES
 --------

Documentation/nvme-capacity-mgmt.txt

@@ -13,8 +13,7 @@ SYNOPSIS
 			[--element-id=<element-id> | -i <element-id>]
 			[--cap-lower=<cap-lower> | -l <cap-lower>]
 			[--cap-upper=<cap-upper> | -u <cap-upper>]
-			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
-			[--timeout=<timeout>]
+			[<global-options>]
 
 DESCRIPTION
 -----------
@@ -47,17 +46,7 @@ OPTIONS
 	Most significant 32 bits of the capacity in bytes of the Endurance Group or
 	NVM Set to be created
 
--o <fmt>::
---output-format=<fmt>::
-	Set the reporting format to 'normal', 'json' or 'binary'. Only one
-	output format can be used at a time.
-
--v::
---verbose::
-	Increase the information detail in the output.
-
---timeout=<timeout>::
-	Override default timeout value. In milliseconds.
+include::global-options.txt[]
 
 EXAMPLES
 --------

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

@@ -10,8 +10,7 @@ SYNOPSIS
 --------
 [verse]
 'nvme changed-alloc-ns-list-log' <device> [--raw-binary | -b]
-			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
-			[--timeout=<timeout>]
+			[<global-options>]
 
 DESCRIPTION
 -----------
@@ -32,17 +31,7 @@ OPTIONS
 --raw-binary::
 	Print the raw Changed Namespace List log buffer to stdout.
 
--o <fmt>::
---output-format=<fmt>::
-	Set the reporting format to 'normal', 'json' or 'binary'. Only one
-	output format can be used at a time.
-
--v::
---verbose::
-	Increase the information detail in the output.
-
---timeout=<timeout>::
-	Override default timeout value. In milliseconds.
+include::global-options.txt[]
 
 EXAMPLES
 --------

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

@@ -10,7 +10,7 @@ SYNOPSIS
 --------
 [verse]
 'nvme changed-ns-list-log' <device> [--raw-binary | -b]
-			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[<global-options>]
 
 DESCRIPTION
 -----------
@@ -31,14 +31,7 @@ OPTIONS
 --raw-binary::
 	Print the raw Changed Namespace List log buffer to stdout.
 
--o <fmt>::
---output-format=<fmt>::
-	Set the reporting format to 'normal', 'json' or 'binary'. Only one
-	output format can be used at a time.
-
--v::
---verbose::
-	Increase the information detail in the output.
+include::global-options.txt[]
 
 EXAMPLES
 --------