doc: Add nvme commands latency option

Since the nvme commands using NVME_ARGS() macro added the latency option.

Signed-off-by: Tokunori Ikegami <[email protected]>

Documentation/nvme-admin-passthru.txt

@@ -24,8 +24,8 @@ SYNOPSIS
 			[--dry-run | -d]
 			[--raw-binary | -b]
 			[--prefill=<prefill> | -p <prefill>]
-			[--latency | -L]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -110,10 +110,6 @@ OPTIONS
 	value. It may also be useful if you need to confirm if a device
 	is overwriting a buffer for a data-in command.
 
--L::
---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
@@ -123,6 +119,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 -t <timeout>::
 --timeout=<timeout>::
 	Override default timeout value. In milliseconds.

Documentation/nvme-ana-log.txt

@@ -10,6 +10,7 @@ SYNOPSIS
 [verse]
 'nvme ana-log' <device> [--groups | -g]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -38,6 +39,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 * Print the ANA log page in a human readable format:

Documentation/nvme-attach-ns.txt

@@ -11,6 +11,7 @@ SYNOPSIS
 'nvme attach-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
 			[--controllers=<ctrl-list,> | -c <ctrl-list,>]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -38,6 +39,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 	Attach namespace to the controller:

Documentation/nvme-boot-part-log.txt

@@ -11,6 +11,7 @@ SYNOPSIS
 'nvme boot-part-log' <device> [--lsp=<field> | -s <field>]
 			[--output-file=<file> | -f <file>]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -42,6 +43,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 * Retrieve Boot Partition data to boot_part_log.bin

Documentation/nvme-capacity-mgmt.txt

@@ -14,6 +14,7 @@ SYNOPSIS
 			[--cap-lower=<cap-lower> | -l <cap-lower>]
 			[--cap-upper=<cap-upper> | -u <cap-upper>]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -55,6 +56,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 No examples provided yet.

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

@@ -11,6 +11,7 @@ SYNOPSIS
 [verse]
 'nvme changed-ns-list-log' <device> [--raw-binary | -b]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -40,6 +41,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 * Print the Changed Namespace List Log page in a human readable format:

Documentation/nvme-check-dhchap-key.txt

@@ -10,6 +10,7 @@ SYNOPSIS
 [verse]
 'nvme check-dhchap-key' [--key=<key>]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -32,6 +33,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 No Examples

Documentation/nvme-check-tls-key.txt

@@ -70,6 +70,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 No Examples

Documentation/nvme-cmdset-ind-id-ns.txt

@@ -11,6 +11,7 @@ SYNOPSIS
 'nvme cmdset-ind-id-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
 			[--raw-binary | -b] [--human-readable | -H]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -55,6 +56,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 * Has the program interpret the returned buffer and display the known

Documentation/nvme-compare.txt

@@ -25,11 +25,11 @@ SYNOPSIS
 			[--dsm=<dsm> | -D <dsm>]
 			[--show-command | -V]
 			[--dry-run | -w]
-			[--latency | -L]
 			[--storage-tag<storage-tag> | -g <storage-tag>]
 			[--storage-tag-check | -C]
 			[--force]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -137,10 +137,6 @@ metadata is passes.
 	--show-cmd option _must_ be set. Otherwise --dry-run option will be
 	_ignored_.
 
--L::
---latency::
-	Print out the latency the IOCTL took (in us).
-
 -g <storage-tag>::
 --storage-tag=<storage-tag>::
 	Variable Sized Expected Logical Block Storage Tag(ELBST).
@@ -163,6 +159,10 @@ metadata is passes.
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 No examples yet.

Documentation/nvme-config.txt

@@ -30,6 +30,7 @@ SYNOPSIS
 			[--duplicate-connect | -D] [--disable-sqflow | -d]
 			[--hdr-digest | -g] [--data-digest | -G]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -190,6 +191,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 * Read the current system configuration and write the contents to /tmp/config.json:

Documentation/nvme-connect-all.txt

@@ -31,6 +31,7 @@ SYNOPSIS
 			[--dump-config | -O] [--nbft] [--no-nbft]
 			[--nbft-path=<STR>] [--context=<STR>]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -216,6 +217,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 * Connect to all records returned by the Discover Controller with IP4 address

Documentation/nvme-connect.txt

@@ -31,6 +31,7 @@ SYNOPSIS
 			[--hdr-digest | -g] [--data-digest | -G] [--tls]
 			[--dump-config | -O] [--application=<id>]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -193,6 +194,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 * Connect to a subsystem named nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432

Documentation/nvme-copy.txt

@@ -27,6 +27,7 @@ SYNOPSIS
 			[--dir-spec=<spec> | -S <spec>]
 			[--format=<entry-format> | -F <entry-format>]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -122,6 +123,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 No examples yet.

Documentation/nvme-create-ns.txt

@@ -29,6 +29,7 @@ SYNOPSIS
 			[--rnumzrwa=<rnumzrwa> | -u <rnumzrwa>]
 			[--phndls=<placement-handle-list,> | -p <placement-handle-list,>]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -144,6 +145,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 -t <timeout>::
 --timeout=<timeout>::
 	Override default timeout value. In milliseconds.

Documentation/nvme-delete-ns.txt

@@ -10,6 +10,7 @@ SYNOPSIS
 [verse]
 'nvme delete-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -35,6 +36,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 No examples yet.

Documentation/nvme-detach-ns.txt

@@ -11,6 +11,7 @@ SYNOPSIS
 'nvme detach-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
 			[--controllers=<ctrl-list,> | -c <ctrl-list,>
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -38,6 +39,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 No examples yet.

Documentation/nvme-device-self-test.txt

@@ -11,6 +11,7 @@ SYNOPSIS
 'nvme device-self-test' <device> [--namespace-id=<NUM> | -n <NUM>]
 			[--self-test-code=<NUM> | -s <NUM>] [--wait | -w]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -52,6 +53,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 * Start a short device self-test in the namespace-id 1:

Documentation/nvme-dim.txt

@@ -12,6 +12,7 @@ SYNOPSIS
 'nvme dim' [--task=<task> | -t <task>] [--nqn=<nqn> | -n <nqn>]
 			[--device=<device> | -d <device>]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--latency | -L]
 
 DESCRIPTION
 -----------
@@ -60,6 +61,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+-L::
+--latency::
+	Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 * Register with the Central Discovery Controller (CDC) named