]> www.infradead.org Git - users/hch/nvme-cli.git/commitdiff
projects / users / hch / nvme-cli.git / commitdiff
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 6317d38)
doc: Update show-regs document with output-format
authorMinwoo Im <minwoo.im.dev@gmail.com>
Sat, 6 Apr 2019 21:12:29 +0000 (06:12 +0900)
committerMinwoo Im <minwoo.im.dev@gmail.com>
Sat, 6 Apr 2019 21:12:29 +0000 (06:12 +0900)
Previous commit has introduced --output-format argument for show-regs
subcommand so that document should be updated.

Signed-off-by: Minwoo Im <minwoo.im.dev@gmail.com>
Documentation/nvme-show-regs.1 patch | blob | history
Documentation/nvme-show-regs.html patch | blob | history
Documentation/nvme-show-regs.txt patch | blob | history

diff --git a/Documentation/nvme-show-regs.1 b/Documentation/nvme-show-regs.1
index a48eb5caaaa2e9ecc86c0d6a86939d87b8bf1933..fabdb240d3575a3d83d4ed7cdfda214331997056 100644 (file)
--- a/Documentation/nvme-show-regs.1
+++ b/Documentation/nvme-show-regs.1
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: nvme-id-ns
-.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
-.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\"      Date: 01/08/2019
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 04/07/2019
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ID\-NS" "1" "01/08/2019" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-NS" "1" "04/07/2019" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -32,7 +32,8 @@ nvme-show-regs \- Reads and shows the defined NVMe controller registers for NVMe
 .SH "SYNOPSIS"
 .sp
 .nf
-\fInvme show\-regs\fR <device> [\-\-human\-readable | \-H]
+\fInvme show\-regs\fR <device>       [\-\-human\-readable | \-H]
+                                [\-\-output\-format=<FMT> | \-o <FMT>]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -45,6 +46,14 @@ The <device> parameter is mandatory and must be the nvme admin character device
 .RS 4
 Display registers or supported properties in human readable format\&.
 .RE
+.PP
+\-o <format>, \-\-output\-format=<format>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR, or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
 .SH "EXAMPLES"
 .sp
 .RS 4
@@ -61,7 +70,7 @@ Show the NVMe over PCIe controller registers or the NVMe over Fabric controller
 .RS 4
 .\}
 .nf
-# nvme show\-regs /dev/nvme0
+# nvme show\-regs /dev/nvme0 \-o binary
 .fi
 .if n \{\
 .RE
@@ -88,6 +97,27 @@ Show the NVMe over PCIe controller registers or the NVMe over Fabric controller
 .RE
 .\}
 .RE
+.sp
+.RS 4
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Show the NVMe over PCIe controller registers or NVMe\-oF controller properties in a json format:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+# nvme show\-regs /dev/nvme0 \-o json
+.fi
+.if n \{\
+.RE
+.\}
+.RE
 .SH "NVME"
 .sp
 Part of the nvme\-user suite
diff --git a/Documentation/nvme-show-regs.html b/Documentation/nvme-show-regs.html
index 913bba4bc01a8ba591bfbf673e57763d1eb96fd6..1b56c4790721d19d9f38a67901459f030c6f8d59 100644 (file)
--- a/Documentation/nvme-show-regs.html
+++ b/Documentation/nvme-show-regs.html
@@ -1,9 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>\r
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
 <head>\r
 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
-<meta name="generator" content="AsciiDoc 8.6.8" />\r
+<meta name="generator" content="AsciiDoc 8.6.10" />\r
 <title>nvme-id-ns(1)</title>\r
 <style type="text/css">\r
 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
@@ -94,7 +95,9 @@ ul > li > * { color: black; }
   padding: 0;\r
   margin: 0;\r
 }\r
-\r
+pre {\r
+  white-space: pre-wrap;\r
+}\r
 \r
 #author {\r
   color: #527bbd;\r
@@ -223,7 +226,7 @@ div.exampleblock > div.content {
 }\r
 \r
 div.imageblock div.content { padding-left: 0; }\r
-span.image img { border-style: none; }\r
+span.image img { border-style: none; vertical-align: text-bottom; }\r
 a.image:visited { color: white; }\r
 \r
 dl {\r
@@ -433,7 +436,7 @@ thead, p.table.header {
 p.table {\r
   margin-top: 0;\r
 }\r
-/* Because the table frame attribute is overridden by CSS in most browsers. */\r
+/* Because the table frame attribute is overriden by CSS in most browsers. */\r
 div.tableblock > table[frame="void"] {\r
   border-style: none;\r
 }\r
@@ -746,7 +749,8 @@ nvme-id-ns(1) Manual Page
 <h2 id="_synopsis">SYNOPSIS</h2>\r
 <div class="sectionbody">\r
 <div class="verseblock">\r
-<pre class="content"><em>nvme show-regs</em> &lt;device&gt; [--human-readable | -H]</pre>\r
+<pre class="content"><em>nvme show-regs</em> &lt;device&gt;       [--human-readable | -H]\r
+                                [--output-format=&lt;FMT&gt; | -o &lt;FMT&gt;]</pre>\r
 <div class="attribution">\r
 </div></div>\r
 </div>\r
@@ -781,6 +785,18 @@ Only the supported properties are displayed.</p></div>
        Display registers or supported properties in human readable format.\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+-o &lt;format&gt;\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=&lt;format&gt;\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
+</p>\r
+</dd>\r
 </dl></div>\r
 </div>\r
 </div>\r
@@ -795,7 +811,7 @@ properties in a binary format:
 </p>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><code># nvme show-regs /dev/nvme0</code></pre>\r
+<pre><code># nvme show-regs /dev/nvme0 -o binary</code></pre>\r
 </div></div>\r
 </li>\r
 <li>\r
@@ -808,6 +824,16 @@ properties in a human readable format:
 <pre><code># nvme show-regs /dev/nvme0 -H</code></pre>\r
 </div></div>\r
 </li>\r
+<li>\r
+<p>\r
+Show the NVMe over PCIe controller registers or NVMe-oF controller properties\r
+in a json format:\r
+</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><code># nvme show-regs /dev/nvme0 -o json</code></pre>\r
+</div></div>\r
+</li>\r
 </ul></div>\r
 </div>\r
 </div>\r
@@ -821,7 +847,8 @@ properties in a human readable format:
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2017-12-13 08:26:02 MST\r
+Last updated\r
+ 2019-04-07 06:12:04 KST\r
 </div>\r
 </div>\r
 </body>\r
diff --git a/Documentation/nvme-show-regs.txt b/Documentation/nvme-show-regs.txt
index bf6c44c716ddbb8e6b5d20766d9dfb4ea85e5963..892b3944386d7d04d3eb5bb6d6d406ffc88f227c 100644 (file)
--- a/Documentation/nvme-show-regs.txt
+++ b/Documentation/nvme-show-regs.txt
@@ -9,7 +9,8 @@ NVMe over PCIe or the controller properties for NVMe over Fabrics.
 SYNOPSIS
 --------
 [verse]
-'nvme show-regs' <device> [--human-readable | -H]
+'nvme show-regs' <device>      [--human-readable | -H]
+                               [--output-format=<FMT> | -o <FMT>]
 
 DESCRIPTION
 -----------
@@ -31,6 +32,10 @@ OPTIONS
 --human-readable::
        Display registers or supported properties in human readable format.
 
+-o <format>::
+--output-format=<format>::
+              Set the reporting format to 'normal', 'json', or
+              'binary'. Only one output format can be used at a time.
 
 EXAMPLES
 --------
@@ -38,7 +43,7 @@ EXAMPLES
 properties in a binary format:
 +
 ------------
-# nvme show-regs /dev/nvme0
+# nvme show-regs /dev/nvme0 -o binary
 ------------
 * Show the NVMe over PCIe controller registers or the NVMe over Fabric controller
 properties in a human readable format:
@@ -46,6 +51,12 @@ properties in a human readable format:
 ------------
 # nvme show-regs /dev/nvme0 -H
 ------------
+* Show the NVMe over PCIe controller registers or NVMe-oF controller properties
+in a json format:
++
+------------
+# nvme show-regs /dev/nvme0 -o json
+------------
 
 NVME
 ----
Unnamed repository; edit this file 'description' to name the repository.