From: Minwoo Im <minwoo.im.dev@gmail.com>
Date: Tue, 23 Jul 2019 15:33:03 +0000 (+0900)
Subject: doc: make description not only for PCIe
X-Git-Tag: v1.9~31^2~1
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=44be4d640038ff8c5a9eb7303ed2f7e57f097e31;p=users%2Fsagi%2Fnvme-cli.git

doc: make description not only for PCIe

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>
---

diff --git a/Documentation/nvme.1 b/Documentation/nvme.1
index 912e5a1e..0b2a8bad 100644
--- a/Documentation/nvme.1
+++ b/Documentation/nvme.1
@@ -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"
diff --git a/Documentation/nvme.html b/Documentation/nvme.html
index ef687291..bad6f1c1 100644
--- a/Documentation/nvme.html
+++ b/Documentation/nvme.html
@@ -740,7 +740,7 @@ nvme(1) Manual Page
 <h2>NAME</h2>
 <div class="sectionbody">
 <p>nvme -
-   the dumb pci-e storage utility
+   the NVMe storage command line interface utility (nvme-cli)
 </p>
 </div>
 </div>
@@ -758,7 +758,8 @@ nvme(1) Manual Page
 <h2 id="_description">DESCRIPTION</h2>
 <div class="sectionbody">
 <div class="paragraph"><p>NVM-Express is a fast, scalable host controller interface designed to
-address the needs for PCI Express based solid state drives.</p></div>
+address the needs for not only PCI Express based solid state drives, but
+also NVMe-oF(over fabrics).</p></div>
 <div class="paragraph"><p>This <em>nvme</em> 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.</p></div>
@@ -1183,7 +1184,7 @@ NVM-Express Site</a>.</p></div>
 <div id="footer">
 <div id="footer-text">
 Last updated
- 2018-09-04 00:00:12 KST
+ 2019-07-24 00:35:34 KST
 </div>
 </div>
 </body>
diff --git a/Documentation/nvme.txt b/Documentation/nvme.txt
index cb640824..0092be79 100644
--- a/Documentation/nvme.txt
+++ b/Documentation/nvme.txt
@@ -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