]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
doc: make description not only for PCIe
authorMinwoo Im <minwoo.im.dev@gmail.com>
Tue, 23 Jul 2019 15:33:03 +0000 (00:33 +0900)
committerMinwoo Im <minwoo.im.dev@gmail.com>
Tue, 23 Jul 2019 15:35:44 +0000 (00:35 +0900)
Now we can have this program not only just for NVMe over PCIe storage,
but also NVMe over fabrics.  This patch updates the document main page
nvme.txt.

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

index 912e5a1e9c96dc219638de13945b5689ad5db936..0b2a8bad89435c8092eb4c9095e8057520baea5a 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme
 .\"    Author: [see the "Authors" section]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 04/04/2019
+.\"      Date: 07/24/2019
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME" "1" "04/04/2019" "NVMe" "NVMe Manual"
+.TH "NVME" "1" "07/24/2019" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -28,7 +28,7 @@
 .\" * MAIN CONTENT STARTS HERE *
 .\" -----------------------------------------------------------------
 .SH "NAME"
-nvme \- the dumb pci\-e storage utility
+nvme \- the NVMe storage command line interface utility (nvme\-cli)
 .SH "SYNOPSIS"
 .sp
 .nf
@@ -36,7 +36,7 @@ nvme \- the dumb pci\-e storage utility
 .fi
 .SH "DESCRIPTION"
 .sp
-NVM\-Express is a fast, scalable host controller interface designed to address the needs for PCI Express based solid state drives\&.
+NVM\-Express is a fast, scalable host controller interface designed to address the needs for not only PCI Express based solid state drives, but also NVMe\-oF(over fabrics)\&.
 .sp
 This \fInvme\fR program is a user space utility to provide standards compliant tooling for NVM\-Express drives\&. It was made specifically for Linux as it relies on the IOCTLs defined by the mainline kernel driver\&.
 .SH "NVME COMMANDS"
index ef6872911c03a5e9cde387fb6b69ef2750dafbf5..bad6f1c1b41200c217b5f3cec5158eb711635e13 100644 (file)
@@ -740,7 +740,7 @@ nvme(1) Manual Page
 <h2>NAME</h2>\r
 <div class="sectionbody">\r
 <p>nvme -\r
-   the dumb pci-e storage utility\r
+   the NVMe storage command line interface utility (nvme-cli)\r
 </p>\r
 </div>\r
 </div>\r
@@ -758,7 +758,8 @@ nvme(1) Manual Page
 <h2 id="_description">DESCRIPTION</h2>\r
 <div class="sectionbody">\r
 <div class="paragraph"><p>NVM-Express is a fast, scalable host controller interface designed to\r
-address the needs for PCI Express based solid state drives.</p></div>\r
+address the needs for not only PCI Express based solid state drives, but\r
+also NVMe-oF(over fabrics).</p></div>\r
 <div class="paragraph"><p>This <em>nvme</em> program is a user space utility to provide standards compliant\r
 tooling for NVM-Express drives. It was made specifically for Linux as\r
 it relies on the IOCTLs defined by the mainline kernel driver.</p></div>\r
@@ -1183,7 +1184,7 @@ NVM-Express Site</a>.</p></div>
 <div id="footer">\r
 <div id="footer-text">\r
 Last updated\r
- 2018-09-04 00:00:12 KST\r
+ 2019-07-24 00:35:34 KST\r
 </div>\r
 </div>\r
 </body>\r
index cb6408249e8474532c57cadf77a978d5b88806e8..0092be79a745d35dc7f95660d99048cdaf0ce773 100644 (file)
@@ -3,7 +3,7 @@ nvme(1)
 
 NAME
 ----
-nvme - the dumb pci-e storage utility
+nvme - the NVMe storage command line interface utility (nvme-cli)
 
 SYNOPSIS
 --------
@@ -13,7 +13,8 @@ SYNOPSIS
 DESCRIPTION
 -----------
 NVM-Express is a fast, scalable host controller interface designed to
-address the needs for PCI Express based solid state drives.
+address the needs for not only PCI Express based solid state drives, but
+also NVMe-oF(over fabrics).
 
 This 'nvme' program is a user space utility to provide standards compliant
 tooling for NVM-Express drives. It was made specifically for Linux as