]> www.infradead.org Git - users/hch/nvme-cli.git/commitdiff
nvme-cli: intel: fix smart-log-add documentation
authorMinwoo Im <minwoo.im.dev@gmail.com>
Fri, 12 Jan 2018 13:10:26 +0000 (22:10 +0900)
committerMinwoo Im <minwoo.im.dev@gmail.com>
Fri, 12 Jan 2018 13:10:26 +0000 (22:10 +0900)
tim-oleksii has reported that intel smart-log-add help differs from man
page.

Update man, html, and txt documentation to follow output of below
command.
    ./nvme intel smart-log-add

Signed-off-by: Minwoo Im <minwoo.im.dev@gmail.com>
Documentation/nvme-intel-smart-log-add.1
Documentation/nvme-intel-smart-log-add.html
Documentation/nvme-intel-smart-log-add.txt

index 20f45d55af4f1b4ac28698acec7af320e961f6c5..9d181a1a6e40f5e0606608670d1ed5734e206919 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-intel-smart-log-add
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 01/11/2018
+.\"      Date: 01/12/2018
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-INTEL\-SMART\-" "1" "01/11/2018" "NVMe" "NVMe Manual"
+.TH "NVME\-INTEL\-SMART\-" "1" "01/12/2018" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -34,7 +34,7 @@ nvme-intel-smart-log-add \- Send NVMe Intel Additional SMART log page request, r
 .nf
 \fInvme intel smart\-log\-add\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
                         [\-\-raw\-binary | \-b]
-                        [\-\-output\-format=<fmt> | \-o <fmt>]
+                        [\-\-json | \-j]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -55,12 +55,9 @@ Retrieve the Additional SMART log for the given nsid\&. This is optional and its
 Print the raw Intel Additional SMART log buffer to stdout\&.
 .RE
 .PP
-\-o <format>, \-\-output\-format=<format>
+\-j, \-\-json
 .RS 4
-Set the reporting format to
-\fInormal\fR,
-\fIjson\fR, or
-\fIbinary\fR\&. Only one output format can be used at a time\&.
+Dump output in json format\&.
 .RE
 .SH "EXAMPLES"
 .sp
index 4a5850749cadff32c3d26ac7be61cbd6933c75af..081a98aa5e85192f0f4db3bcf4f9b4e17dc350b8 100644 (file)
@@ -750,7 +750,7 @@ nvme-intel-smart-log-add(1) Manual Page
 <div class="verseblock">\r
 <pre class="content"><em>nvme intel smart-log-add</em> &lt;device&gt; [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]\r
                         [--raw-binary | -b]\r
-                        [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>\r
+                        [--json | -j]</pre>\r
 <div class="attribution">\r
 </div></div>\r
 </div>\r
@@ -799,15 +799,14 @@ printed to stdout for another program to parse.</p></div>
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
--o &lt;format&gt;\r
+-j\r
 </dt>\r
 <dt class="hdlist1">\r
---output-format=&lt;format&gt;\r
+--json\r
 </dt>\r
 <dd>\r
 <p>\r
-              Set the reporting format to <em>normal</em>, <em>json</em>, or\r
-              <em>binary</em>. Only one output format can be used at a time.\r
+              Dump output in <em>json</em> format.\r
 </p>\r
 </dd>\r
 </dl></div>\r
index 3cb0f9a7d00d44bdabc02af71df6555c5f9bb28b..932a625dee97aaa1d0be80f42881e9d8008b29a9 100644 (file)
@@ -10,7 +10,7 @@ SYNOPSIS
 [verse]
 'nvme intel smart-log-add' <device> [--namespace-id=<nsid> | -n <nsid>]
                        [--raw-binary | -b]
-                       [--output-format=<fmt> | -o <fmt>]
+                       [--json | -j]
 
 DESCRIPTION
 -----------
@@ -39,10 +39,9 @@ OPTIONS
 --raw-binary::
        Print the raw Intel Additional SMART log buffer to stdout.
 
--o <format>::
---output-format=<format>::
-              Set the reporting format to 'normal', 'json', or
-              'binary'. Only one output format can be used at a time.
+-j::
+--json::
+              Dump output in json format.
 
 EXAMPLES
 --------