From 7aa8985674afda57f168c1124607dbe004b23a81 Mon Sep 17 00:00:00 2001 From: Tokunori Ikegami Date: Wed, 1 Apr 2026 00:28:38 +0900 Subject: [PATCH] doc: add output-format-version option description Describe as the default value is 2. Signed-off-by: Tokunori Ikegami --- Documentation/nvme-ocp-smart-add-log.txt | 10 ++++------ Documentation/nvme.txt | 8 ++++++++ 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/Documentation/nvme-ocp-smart-add-log.txt b/Documentation/nvme-ocp-smart-add-log.txt index 97192d6940..a5614d242c 100644 --- a/Documentation/nvme-ocp-smart-add-log.txt +++ b/Documentation/nvme-ocp-smart-add-log.txt @@ -9,7 +9,8 @@ compliant device SYNOPSIS -------- [verse] -'nvme ocp smart-add-log' [--output-format= | -o ] [--output-format-version=] +'nvme ocp smart-add-log' [--output-format= | -o ] + [--output-format-version=] DESCRIPTION ----------- @@ -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 @@ -37,7 +34,8 @@ OPTIONS --output-format-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 -------- diff --git a/Documentation/nvme.txt b/Documentation/nvme.txt index 87de7b837d..4fbc516b67 100644 --- a/Documentation/nvme.txt +++ b/Documentation/nvme.txt @@ -10,6 +10,7 @@ SYNOPSIS built-in plugin: [verse] 'nvme' [] + [--output-format-version=] extension plugins: [verse] @@ -45,6 +46,13 @@ Plugins/Vendor extension commands include::cmd-plugins.txt[] +OPTIONS +------- +--output-format-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