doc: add output-format-version option description

Describe as the default value is 2.

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

Author: ikegami-t

Documentation/nvme-dir-receive.txt

@@ -17,6 +17,7 @@ SYNOPSIS
 			[--human-readable | -H] [--raw-binary | -b]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
 			[--timeout=<timeout>]
+			[--output-format-version=<version>]
 
 DESCRIPTION
 -----------
@@ -27,6 +28,10 @@ well as number of requested resource if specific operation needs it.
 The <device> parameter is mandatory and may be either the NVMe character
 device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
 
+EXPERIMENTAL. The --output-format-version can be set to 2 to generate field names
+for the outputs that are easier to process via scripts. Note this is
+experimental and the field names are subject to change.
+
 On success, the returned directive's parameter structure (if applicable) is 
 returned in one of several ways depending on the option flags; the
 structure may parsed by the program and printed in a readable format
@@ -94,6 +99,10 @@ OPTIONS
 --timeout=<timeout>::
 	Override default timeout value. In milliseconds.
 
+--output-format-version=<version>::
+	Set the field labels in the reporting format to either '1'
+	(the original) or '2'. The default is 2. Note this is experimental.
+
 EXAMPLES
 --------
 * Identify directive type supported :

Documentation/nvme-get-property.txt

@@ -13,11 +13,16 @@ SYNOPSIS
 			[--human-readable | -H]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
 			[--timeout=<timeout>]
+			[--output-format-version=<version>]
 
 DESCRIPTION
 -----------
 Reads and shows the defined NVMe controller property for NVMe over Fabric.
 
+EXPERIMENTAL. The --output-format-version can be set to 2 to generate field names
+for the outputs that are easier to process via scripts. Note this is
+experimental and the field names are subject to change.
+
 OPTIONS
 -------
 -O <offset>::
@@ -40,6 +45,10 @@ OPTIONS
 --timeout=<timeout>::
 	Override default timeout value. In milliseconds.
 
+--output-format-version=<version>::
+	Set the field labels in the reporting format to either '1'
+	(the original) or '2'. The default is 2. Note this is experimental.
+
 EXAMPLES
 --------
 * The following will run the get-property command with offset 0

Documentation/nvme-get-reg.txt

@@ -17,6 +17,7 @@ SYNOPSIS
 			[--pmrmscl] [--pmrmscu]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
 			[--timeout=<timeout>]
+			[--output-format-version=<version>]
 
 DESCRIPTION
 -----------
@@ -25,6 +26,10 @@ Read and show the defined NVMe controller register.
 The <device> parameter is mandatory and must be the nvme admin character
 device (ex: /dev/nvme0).
 
+EXPERIMENTAL. The --output-format-version can be set to 2 to generate field names
+for the outputs that are easier to process via scripts. Note this is
+experimental and the field names are subject to change.
+
 OPTIONS
 -------
 -O <offset>::
@@ -131,6 +136,10 @@ OPTIONS
 --timeout=<timeout>::
 	Override default timeout value. In milliseconds.
 
+--output-format-version=<version>::
+	Set the field labels in the reporting format to either '1'
+	(the original) or '2'. The default is 2. Note this is experimental.
+
 EXAMPLES
 --------
 * The following will run the get-reg command with CC=0x14 register offset

Documentation/nvme-id-ns-lba-format.txt

@@ -12,6 +12,7 @@ SYNOPSIS
 			[--lba-format-index=<lba_format_index> | -i <lba_format_index>]
 			[--verbose | -v]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--output-format-version=<version>]
 
 DESCRIPTION
 -----------
@@ -22,6 +23,10 @@ that is include capability field only and returned structure.
 The <device> parameter is mandatory and may be either the NVMe character
 device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
 
+EXPERIMENTAL. The --output-format-version can be set to 2 to generate field names
+for the outputs that are easier to process via scripts. Note this is
+experimental and the field names are subject to change.
+
 On success, the structure may be returned in one of several ways depending
 on the option flags; the structure may be parsed by the program or the
 raw buffer may be printed to stdout.
@@ -46,6 +51,10 @@ OPTIONS
 	Set the reporting format to 'normal', 'json' or 'binary'. Only one
 	output format can be used at a time.
 
+--output-format-version=<version>::
+	Set the field labels in the reporting format to either '1'
+	(the original) or '2'. The default is 2. Note this is experimental.
+
 EXAMPLES
 --------
 * Has the program interpret the returned buffer and display the known

Documentation/nvme-id-ns.txt

@@ -12,6 +12,7 @@ SYNOPSIS
 			[--namespace-id=<nsid> | -n <nsid>] [--force]
 			[--human-readable | -H]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--output-format-version=<version>]
 
 DESCRIPTION
 -----------
@@ -25,6 +26,10 @@ mandatory, otherwise it will use the ns-id of the namespace for the block
 device you opened. For block devices, the ns-id used can be overridden
 with the same option.
 
+EXPERIMENTAL. The --output-format-version can be set to 2 to generate field names
+for the outputs that are easier to process via scripts. Note this is
+experimental and the field names are subject to change.
+
 On success, the structure may be returned in one of several ways depending
 on the option flags; the structure may be parsed by the program or the
 raw buffer may be printed to stdout.
@@ -71,6 +76,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+--output-format-version=<version>::
+	Set the field labels in the reporting format to either '1'
+	(the original) or '2'. The default is 2. Note this is experimental.
+
 EXAMPLES
 --------
 * Has the program interpret the returned buffer and display the known

Documentation/nvme-list-subsys.txt

@@ -9,6 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'nvme list-subsys' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--output-format-version=<version>]
 
 DESCRIPTION
 -----------
@@ -17,6 +18,10 @@ for those subsystems as well as some pertinent information about them.
 If a device is given, print out only the values for the controllers
 and subsystems leading to the device.
 
+EXPERIMENTAL. The --output-format-version can be set to 2 to generate field names
+for the outputs that are easier to process via scripts. Note this is
+experimental and the field names are subject to change.
+
 OPTIONS
 -------
 -o <fmt>::
@@ -28,6 +33,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+--output-format-version=<version>::
+	Set the field labels in the reporting format to either '1'
+	(the original) or '2'. The default is 2. Note this is experimental.
+
 EXAMPLES
 --------
 [verse]

Documentation/nvme-list.txt

@@ -9,13 +9,18 @@ SYNOPSIS
 --------
 [verse]
 'nvme list' [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--output-format-version=<version>]
 
 DESCRIPTION
 -----------
 Scan the sysfs tree for NVM Express devices and return the /dev node
 for those devices as well as some pertinent information about them.
 Namespace usage printed in powers of 1,000 with SI prefixes. (e.g., 1.02  TB)
 
+EXPERIMENTAL. The --output-format-version can be set to 2 to generate field names
+for the outputs that are easier to process via scripts. Note this is
+experimental and the field names are subject to change.
+
 OPTIONS
 -------
 -o <fmt>::
@@ -29,6 +34,10 @@ OPTIONS
 	controllers and namespaces separately and how they're related to each
 	other.
 
+--output-format-version=<version>::
+	Set the field labels in the reporting format to either '1'
+	(the original) or '2'. The default is 2. Note this is experimental.
+
 ENVIRONMENT
 -----------
 PCI_IDS_PATH - Full path of pci.ids file in case nvme could not find it in common locations.

Documentation/nvme-nvm-id-ctrl.txt

@@ -9,6 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'nvme nvm-id-ctrl' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+			[--output-format-version=<version>]
 
 DESCRIPTION
 -----------
@@ -18,6 +19,10 @@ command and provides the result and returned structure.
 The <device> parameter is mandatory and may be either the NVMe character
 device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
 
+EXPERIMENTAL. The --output-format-version can be set to 2 to generate field names
+for the outputs that are easier to process via scripts. Note this is
+experimental and the field names are subject to change.
+
 On success, the data structure returned by the device will be decoded and
 displayed in one of several ways.
 
@@ -32,6 +37,10 @@ OPTIONS
 --verbose::
 	Increase the information detail in the output.
 
+--output-format-version=<version>::
+	Set the field labels in the reporting format to either '1'
+	(the original) or '2'. The default is 2. Note this is experimental.
+
 EXAMPLES
 --------
 * Has the program interpret the returned buffer and display the known

Documentation/nvme-ocp-smart-add-log.txt

@@ -37,7 +37,7 @@ OPTIONS
 
 --output-format-version=<version>::
 	Set the field labels in the reporting format to either '1'
-	(the original) or '2'. The default is 1. Note this is experimental.
+	(the original) or '2'. The default is 2. Note this is experimental.
 
 EXAMPLES
 --------

Documentation/nvme-show-regs.txt

@@ -12,6 +12,7 @@ SYNOPSIS
 'nvme show-regs' <device> [--human-readable | -H]
 			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
 			[--timeout=<timeout>]
+			[--output-format-version=<version>]
 
 DESCRIPTION
 -----------
@@ -27,6 +28,10 @@ memory to get access to the registers. For NVMe over Fabrics, the programs
 sends a fabric command to get the properties of the target NVMe controller.
 Only the supported properties are displayed.
 
+EXPERIMENTAL. The --output-format-version can be set to 2 to generate field names
+for the outputs that are easier to process via scripts. Note this is
+experimental and the field names are subject to change.
+
 OPTIONS
 -------
 -H::
@@ -45,6 +50,10 @@ OPTIONS
 --timeout=<timeout>::
 	Override default timeout value. In milliseconds.
 
+--output-format-version=<version>::
+	Set the field labels in the reporting format to either '1'
+	(the original) or '2'. The default is 2. Note this is experimental.
+
 EXAMPLES
 --------
 * Show the NVMe over PCIe controller registers or the NVMe over Fabric controller