Skip to content

Commit 7aa8985

Browse files
committed
doc: add output-format-version option description
Describe as the default value is 2. Signed-off-by: Tokunori Ikegami <[email protected]>
1 parent 27af156 commit 7aa8985

2 files changed

Lines changed: 12 additions & 6 deletions

File tree

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ compliant device
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'nvme ocp smart-add-log' <device> [--output-format=<fmt> | -o <fmt>] [--output-format-version=<version>]
12+
'nvme ocp smart-add-log' <device> [--output-format=<fmt> | -o <fmt>]
13+
[--output-format-version=<version>]
1314

1415
DESCRIPTION
1516
-----------
@@ -22,10 +23,6 @@ device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).
2223
This will only work on OCP compliant devices supporting this feature.
2324
Results for any other device are undefined.
2425

25-
EXPERIMENTAL. The --output-format-version can be set to 2 to generate field names
26-
for the outputs that are easier to process via scripts. Note this is
27-
experimental and the field names are subject to change.
28-
2926
On success it returns 0, error code otherwise.
3027

3128
OPTIONS
@@ -37,7 +34,8 @@ OPTIONS
3734

3835
--output-format-version=<version>::
3936
Set the field labels in the reporting format to either '1'
40-
(the original) or '2'. The default is 1. Note this is experimental.
37+
(the original) or '2'. The default is 2 to generate field names
38+
for the outputs that are easier to process via scripts.
4139

4240
EXAMPLES
4341
--------

Documentation/nvme.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ SYNOPSIS
1010
built-in plugin:
1111
[verse]
1212
'nvme' <command> <device> [<args>]
13+
[--output-format-version=<version>]
1314

1415
extension plugins:
1516
[verse]
@@ -45,6 +46,13 @@ Plugins/Vendor extension commands
4546

4647
include::cmd-plugins.txt[]
4748

49+
OPTIONS
50+
-------
51+
--output-format-version=<version>::
52+
Set the field labels in the reporting format to either '1'
53+
(the original) or '2'. The default is 2 to generate field names
54+
for the outputs that are easier to process via scripts.
55+
4856
RETURNS
4957
-------
5058
All commands will behave the same, they will return 0 on success and 1 on

0 commit comments

Comments
 (0)