Add json format to list command

Updating man page with new options.

Signed-off-by: Keith Busch <keith.busch@intel.com>

diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1
index 35a8f42240ae09fc160907d10d1cd268ebf8708f..c819a4ec206f7e24ab8ac5d024f1ca3a650815ec 100644 (file)
--- a/Documentation/nvme-connect.1
+++ b/Documentation/nvme-connect.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-connect
 .\"    Author: [see the "AUTHORS" section]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 09/30/2016
+.\"      Date: 10/10/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-CONNECT" "1" "09/30/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-CONNECT" "1" "10/10/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------

diff --git a/Documentation/nvme-discover.1 b/Documentation/nvme-discover.1
index 566816e32303940b911178ed1185a6a51247e9d4..0eacb03ef38040a7041f2defb03faafb695f2b73 100644 (file)
--- a/Documentation/nvme-discover.1
+++ b/Documentation/nvme-discover.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-discover
 .\"    Author: [see the "AUTHORS" section]
 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\"      Date: 09/30/2016
+.\"      Date: 10/10/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-DISCOVER" "1" "09/30/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-DISCOVER" "1" "10/10/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -147,8 +147,13 @@ command using a /etc/nvme/discovery\&.conf file:
 .RS 4
 .\}
 .nf
-# Machine default\&. Note currently only works for single command:
-\-t rdma \-a 192\&.168\&.1\&.4 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432
+# Machine default \*(Aqnvme discover\*(Aq commands\&.  Query the
+# Discovery Controller\*(Aqs two ports (some resources may only
+# be accessible on a single port)\&.  Note an official
+# nqn (Host) name defined in the NVMe specification is being used
+# in this example\&.
+\-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432
+\-t rdma \-a 192\&.168\&.1\&.4   \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432
 
 At the prompt type "nvme discover"\&.
 .fi

diff --git a/Documentation/nvme-discover.html b/Documentation/nvme-discover.html
index 3ff786db17ae9d3ae7678fa38282a512a2cdd88f..9b63c3ca59ed9482c642ecaf4e672f7d4d864872 100644 (file)
--- a/Documentation/nvme-discover.html
+++ b/Documentation/nvme-discover.html
@@ -912,8 +912,13 @@ Issue a <em>nvme discover</em> command using a /etc/nvme/discovery.conf file:
 </ul></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt># Machine default. Note currently only works for single command:\r
--t rdma -a 192.168.1.4 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432\r
+<pre><tt># Machine default 'nvme discover' commands.  Query the\r
+# Discovery Controller's two ports (some resources may only\r
+# be accessible on a single port).  Note an official\r
+# nqn (Host) name defined in the NVMe specification is being used\r
+# in this example.\r
+-t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432\r
+-t rdma -a 192.168.1.4   -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432\r
 \r
 At the prompt type "nvme discover".</tt></pre>\r
 </div></div>\r
@@ -950,7 +955,7 @@ before merging to <a href="https://github.com/linux-nvme/nvme-cli">https://githu
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2016-09-29 12:40:44 MDT\r
+Last updated 2016-10-10 12:06:21 MDT\r
 </div>\r
 </div>\r
 </body>\r

diff --git a/Documentation/nvme-list.1 b/Documentation/nvme-list.1
index c9ee0bfc06933666425e9dfd06d3fa02ce7eb7ee..ef1f8d816756d2cf8f7b0c5d7e6bb4a0ac0f7274 100644 (file)
--- a/Documentation/nvme-list.1
+++ b/Documentation/nvme-list.1
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: nvme-list
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 09/29/2016
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 10/10/2016
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-LIST" "1" "09/29/2016" "NVMe" "NVMe Manual"
+.TH "NVME\-LIST" "1" "10/10/2016" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -32,14 +32,20 @@ nvme-list \- List all recognized NVMe devices
 .SH "SYNOPSIS"
 .sp
 .nf
-\fInvme list\fR
+\fInvme list\fR [\-o <fmt> | \-\-output\-format=<fmt>]
 .fi
 .SH "DESCRIPTION"
 .sp
 Scan the sysfs tree for NVM Express devices and return the /dev node for those devices as well as some pertinent information about them\&.
 .SH "OPTIONS"
-.sp
-No options yet\&.
+.PP
+\-o <format>, \-\-output\-format=<format>
+.RS 4
+Set the reporting format to
+\fInormal\fR
+or
+\fIjson\fR\&. Only one output format can be used at a time\&.
+.RE
 .SH "EXAMPLES"
 .sp
 No examples yet\&.

diff --git a/Documentation/nvme-list.html b/Documentation/nvme-list.html
index cdc4170d6de370f779c03e9fdf971e03654808a9..7487fc4746a76f5be5dc179ada75b6a3d15a4cfe 100644 (file)
--- a/Documentation/nvme-list.html
+++ b/Documentation/nvme-list.html
@@ -752,7 +752,7 @@ nvme-list(1) Manual Page
 <h2 id="_synopsis">SYNOPSIS</h2>\r
 <div class="sectionbody">\r
 <div class="verseblock">\r
-<pre class="content"><em>nvme list</em></pre>\r
+<pre class="content"><em>nvme list</em> [-o &lt;fmt&gt; | --output-format=&lt;fmt&gt;]</pre>\r
 <div class="attribution">\r
 </div></div>\r
 </div>\r
@@ -767,7 +767,20 @@ for those devices as well as some pertinent information about them.</p></div>
 <div class="sect1">\r
 <h2 id="_options">OPTIONS</h2>\r
 <div class="sectionbody">\r
-<div class="paragraph"><p>No options yet.</p></div>\r
+<div class="dlist"><dl>\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> or <em>json</em>. Only one output\r
+        format can be used at a time.\r
+</p>\r
+</dd>\r
+</dl></div>\r
 </div>\r
 </div>\r
 <div class="sect1">\r
@@ -786,7 +799,7 @@ for those devices as well as some pertinent information about them.</p></div>
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2016-06-20 09:01:26 MDT\r
+Last updated 2016-10-10 14:28:53 MDT\r
 </div>\r
 </div>\r
 </body>\r

diff --git a/Documentation/nvme-list.txt b/Documentation/nvme-list.txt
index ae69f8a4aca5b0e4aabf71c91cc1da90a27c7da7..a0326f5ebdb0f0a3cc38d39238e80735ffb17033 100644 (file)
--- a/Documentation/nvme-list.txt
+++ b/Documentation/nvme-list.txt
@@ -8,7 +8,7 @@ nvme-list - List all recognized NVMe devices
 SYNOPSIS
 --------
 [verse]
-'nvme list' 
+'nvme list' [-o <fmt> | --output-format=<fmt>]
 
 DESCRIPTION
 -----------
@@ -17,7 +17,10 @@ for those devices as well as some pertinent information about them.
 
 OPTIONS
 -------
-No options yet.
+-o <format>::
+--output-format=<format>::
+       Set the reporting format to 'normal' or 'json'. Only one output
+       format can be used at a time.
 
 EXAMPLES
 --------