Skip to content

doc: add output-format-version option description #3222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
igaw merged 1 commit into from
Apr 1, 2026
Merged

doc: add output-format-version option description #3222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions Documentation/nvme-ocp-smart-add-log.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ compliant device
SYNOPSIS
--------
[verse]
'nvme ocp smart-add-log' <device> [--output-format=<fmt> | -o <fmt>] [--output-format-version=<version>]
'nvme ocp smart-add-log' <device> [--output-format=<fmt> | -o <fmt>]
[--output-format-version=<version>]

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

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 it returns 0, error code otherwise.

OPTIONS
Expand All @@ -37,7 +34,8 @@ 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 to generate field names
for the outputs that are easier to process via scripts.

EXAMPLES
--------
Expand Down
8 changes: 8 additions & 0 deletions Documentation/nvme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ SYNOPSIS
built-in plugin:
[verse]
'nvme' <command> <device> [<args>]
[--output-format-version=<version>]

extension plugins:
[verse]
Expand Down Expand Up @@ -45,6 +46,13 @@ Plugins/Vendor extension commands

include::cmd-plugins.txt[]

OPTIONS
-------
--output-format-version=<version>::
Set the field labels in the reporting format to either '1'
(the original) or '2'. The default is 2 to generate field names
for the outputs that are easier to process via scripts.

RETURNS
-------
All commands will behave the same, they will return 0 on success and 1 on
Expand Down
Loading