]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
projects / users / sagi / nvme-cli.git / commitdiff
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 3b83fde)
docs: Update nvme-connect
authorDaniel Wagner <dwagner@suse.de>
Fri, 17 Dec 2021 17:44:43 +0000 (18:44 +0100)
committerDaniel Wagner <dwagner@suse.de>
Fri, 17 Dec 2021 17:44:43 +0000 (18:44 +0100)
0ad49ade724e ("Print device name on connect") added new option,
update the generated documetation.

Signed-off-by: Daniel Wagner <dwagner@suse.de>
Documentation/nvme-connect.1 patch | blob | history
Documentation/nvme-connect.html patch | blob | history

diff --git a/Documentation/nvme-connect.1 b/Documentation/nvme-connect.1
index d4675410a70919ab14fbf2b935af68a15486825d..b973cb9e7f16ed94cb39cb4b804bf80ac22e37e9 100644 (file)
--- a/Documentation/nvme-connect.1
+++ b/Documentation/nvme-connect.1
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: nvme-connect
 .\"    Author: [see the "AUTHORS" section]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 11/25/2021
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\"      Date: 12/17/2021
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-CONNECT" "1" "11/25/2021" "NVMe" "NVMe Manual"
+.TH "NVME\-CONNECT" "1" "12/17/2021" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -56,6 +56,7 @@ nvme-connect \- Connect to a Fabrics controller\&.
                 [\-\-hdr\-digest             | \-g]
                 [\-\-data\-digest            | \-G]
                 [\-\-dump\-config            | \-O]
+                [\-\-output\-format=<fmt>    | \-o <fmt>]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -216,6 +217,14 @@ Generates/verifies data digest (TCP)\&.
 .RS 4
 Print out resulting JSON configuration file to stdout\&.
 .RE
+.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\&. When this option is specified, the device associated with the connection will be printed\&. Nothing is printed otherwise\&.
+.RE
 .SH "EXAMPLES"
 .sp
 .RS 4
diff --git a/Documentation/nvme-connect.html b/Documentation/nvme-connect.html
index ad0a60d418edeac3ead7f49a82f3c5cd3ab6c3b2..048f8c7edd5960ff5485331884235f7ecd0d7439 100644 (file)
--- a/Documentation/nvme-connect.html
+++ b/Documentation/nvme-connect.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" />\r
 <title>nvme-connect(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 overriden by CSS in most browsers. */\r
+/* Because the table frame attribute is overridden by CSS in most browsers. */\r
 div.tableblock > table[frame="void"] {\r
   border-style: none;\r
 }\r
@@ -769,7 +772,8 @@ nvme-connect(1) Manual Page
                 [--disable-sqflow         | -d]\r
                 [--hdr-digest             | -g]\r
                 [--data-digest            | -G]\r
-                [--dump-config            | -O]</pre>\r
+                [--dump-config            | -O]\r
+                [--output-format=&lt;fmt&gt;    | -o &lt;fmt&gt;]</pre>\r
 <div class="attribution">\r
 </div></div>\r
 </div>\r
@@ -1099,6 +1103,19 @@ cellspacing="0" cellpadding="4">
         Print out resulting JSON configuration file to stdout.\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> or <em>json</em>. Only one output format can\r
+        be used at a time. When this option is specified, the device associated with\r
+        the connection will be printed. Nothing is printed otherwise.\r
+</p>\r
+</dd>\r
 </dl></div>\r
 </div>\r
 </div>\r
@@ -1144,7 +1161,8 @@ and <a href="mailto:hch@lst.de">Christoph Hellwig</a></p></div>
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2021-11-25 14:00:47 KST\r
+Last updated\r
+ 2021-12-17 18:38:43 CET\r
 </div>\r
 </div>\r
 </body>\r
Unnamed repository; edit this file 'description' to name the repository.