]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
nvme: update passthru commands man page with latency parameter details
authorGollu Appalanaidu <anaidu.gollu@samsung.com>
Fri, 4 Jun 2021 05:31:54 +0000 (11:01 +0530)
committerKeith Busch <kbusch@kernel.org>
Fri, 11 Jun 2021 15:56:55 +0000 (09:56 -0600)
Signed-off-by: Gollu Appalanaidu <anaidu.gollu@samsung.com>
Documentation/nvme-admin-passthru.1
Documentation/nvme-admin-passthru.html
Documentation/nvme-admin-passthru.txt
Documentation/nvme-io-passthru.1
Documentation/nvme-io-passthru.html
Documentation/nvme-io-passthru.txt

index 286709f53ba383a9f0bd685305ad49928c2c00ba..8cf00954e0595f1be61fc20a248938348b6d855f 100644 (file)
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: nvme-admin-passthru
-.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
-.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\"      Date: 10/20/2020
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 06/04/2021
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ADMIN\-PASSTHR" "1" "10/20/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-ADMIN\-PASSTHR" "1" "06/04/2021" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -46,6 +46,7 @@ nvme-admin-passthru \- Submit an arbitrary admin command, return results
                 [\-\-dry\-run | \-d]
                 [\-\-raw\-binary | \-b]
                 [\-\-prefill=<prefill> | \-p <prefill>]
+                [\-\-latency | \-T]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -123,6 +124,11 @@ Print the raw returned buffer to stdout if the command returns a structure\&.
 .RS 4
 Prefill the buffer with a predetermined byte value\&. Defaults to 0\&. This may be useful if the data you are writing is shorter than the required buffer, and you need to pad it with a known value\&. It may also be useful if you need to confirm if a device is overwriting a buffer for a data\-in command\&.
 .RE
+.PP
+\-T, \-\-latency
+.RS 4
+Print out the latency the IOCTL took (in us)\&.
+.RE
 .SH "EXAMPLES"
 .sp
 .RS 4
index 4a113ba018135a1aa9dc27dc9cce1aabec57ec0e..63a7a102f853ab90ef53cbe2fedcbfd781eec432 100644 (file)
@@ -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-admin-passthru(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
@@ -759,7 +762,8 @@ nvme-admin-passthru(1) Manual Page
                 [--show-command | -s]\r
                 [--dry-run | -d]\r
                 [--raw-binary | -b]\r
-                [--prefill=&lt;prefill&gt; | -p &lt;prefill&gt;]</pre>\r
+                [--prefill=&lt;prefill&gt; | -p &lt;prefill&gt;]\r
+                [--latency | -T]</pre>\r
 <div class="attribution">\r
 </div></div>\r
 </div>\r
@@ -941,6 +945,17 @@ printed to stdout for another program to parse.</p></div>
         is overwriting a buffer for a data-in command.\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+-T\r
+</dt>\r
+<dt class="hdlist1">\r
+--latency\r
+</dt>\r
+<dd>\r
+<p>\r
+        Print out the latency the IOCTL took (in us).\r
+</p>\r
+</dd>\r
 </dl></div>\r
 </div>\r
 </div>\r
@@ -982,7 +997,8 @@ Or if you want to save that structure to a file:
 <div id="footnotes"><hr /></div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 2019-09-06 10:35:44 MDT\r
+Last updated\r
+ 2021-06-04 10:59:04 IST\r
 </div>\r
 </div>\r
 </body>\r
index f2bff2ed3aa55c32986248d1cf1979d7713b1563..ce452fa2b157337b370e5846b6a7f91f2a2d5b0a 100644 (file)
@@ -22,6 +22,7 @@ SYNOPSIS
                [--dry-run | -d]
                [--raw-binary | -b]
                [--prefill=<prefill> | -p <prefill>]
+               [--latency | -T]
 
 DESCRIPTION
 -----------
@@ -105,6 +106,10 @@ OPTIONS
        value. It may also be useful if you need to confirm if a device
        is overwriting a buffer for a data-in command.
 
+-T::
+--latency::
+       Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------
 * The following will run the admin command with opcode=6 and cdw10=1, which
index b5e4322ae443c4c992f5c4e926a50420dde2f782..ad913cc42fe0ec14efbf7a7f33646efada32a668 100644 (file)
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: nvme-io-passthru
-.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
-.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\"      Date: 10/20/2020
+.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 06/04/2021
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-IO\-PASSTHRU" "1" "10/20/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-IO\-PASSTHRU" "1" "06/04/2021" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -47,6 +47,7 @@ nvme-io-passthru \- Submit an arbitrary io command, return results
                 [\-\-dry\-run | \-d]
                 [\-\-raw\-binary | \-b]
                 [\-\-prefill=<prefill> | \-p <prefill>]
+                [\-\-latency | \-T]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -125,6 +126,11 @@ Print the raw returned buffer to stdout if the command returns data or a structu
 .RS 4
 Prefill the buffer with a predetermined byte value\&. Defaults to 0\&. This may be useful if the data you are writing is shorter than the required buffer, and you need to pad it with a known value\&. It may also be useful if you need to confirm if a device is overwriting a buffer on a data\-in command\&.
 .RE
+.PP
+\-T, \-\-latency
+.RS 4
+Print out the latency the IOCTL took (in us)\&.
+.RE
 .SH "EXAMPLES"
 .sp
 nvme io\-passthru /dev/nvme0n1 \-\-opcode=2 \-\-namespace\-id=1 \-\-data\-len=4096 \-\-read \-\-cdw10=0 \-\-cdw11=0 \-\-cdw12=0x70000 \-\-raw\-binary
index 96b9e1e448dea435e26cc8ea1907e430281e85c1..8463c5fda51694742cc9f0b670cd84c28806dd76 100644 (file)
@@ -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.9" />\r
+<meta name="generator" content="AsciiDoc 8.6.10" />\r
 <title>nvme-io-passthru(1)</title>\r
 <style type="text/css">\r
 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */\r
@@ -435,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
@@ -762,7 +763,8 @@ nvme-io-passthru(1) Manual Page
                 [--show-command | -s]\r
                 [--dry-run | -d]\r
                 [--raw-binary | -b]\r
-                [--prefill=&lt;prefill&gt; | -p &lt;prefill&gt;]</pre>\r
+                [--prefill=&lt;prefill&gt; | -p &lt;prefill&gt;]\r
+                [--latency | -T]</pre>\r
 <div class="attribution">\r
 </div></div>\r
 </div>\r
@@ -944,6 +946,17 @@ printed to stdout for another program to parse.</p></div>
         is overwriting a buffer on a data-in command.\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+-T\r
+</dt>\r
+<dt class="hdlist1">\r
+--latency\r
+</dt>\r
+<dd>\r
+<p>\r
+        Print out the latency the IOCTL took (in us).\r
+</p>\r
+</dd>\r
 </dl></div>\r
 </div>\r
 </div>\r
@@ -964,7 +977,7 @@ printed to stdout for another program to parse.</p></div>
 <div id="footer">\r
 <div id="footer-text">\r
 Last updated\r
- 2018-01-30 19:28:39 KST\r
+ 2021-06-04 10:59:48 IST\r
 </div>\r
 </div>\r
 </body>\r
index 318e801dcbc673dcc96b23e3f6c7a0e845527d8b..5a16698e09ca5e1bf9f932968a1b6e2c6bd33fe4 100644 (file)
@@ -23,6 +23,7 @@ SYNOPSIS
                [--dry-run | -d]
                [--raw-binary | -b]
                [--prefill=<prefill> | -p <prefill>]
+               [--latency | -T]
 
 DESCRIPTION
 -----------
@@ -106,6 +107,10 @@ OPTIONS
        value. It may also be useful if you need to confirm if a device
        is overwriting a buffer on a data-in command.
 
+-T::
+--latency::
+       Print out the latency the IOCTL took (in us).
+
 EXAMPLES
 --------