Skip to content

Commit c6fa53d

Browse files
author
Keith Busch
authored
Merge pull request #528 from minwooim/for-1.9/update-nvme-doc
Update for the main nvme documentation
2 parents 5ef97a3 + bda663a commit c6fa53d

3 files changed

Lines changed: 31 additions & 10 deletions

File tree

Documentation/nvme.1

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: nvme
33
.\" Author: [see the "Authors" section]
44
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
5-
.\" Date: 04/04/2019
5+
.\" Date: 07/24/2019
66
.\" Manual: NVMe Manual
77
.\" Source: NVMe
88
.\" Language: English
99
.\"
10-
.TH "NVME" "1" "04/04/2019" "NVMe" "NVMe Manual"
10+
.TH "NVME" "1" "07/24/2019" "NVMe" "NVMe Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -28,15 +28,23 @@
2828
.\" * MAIN CONTENT STARTS HERE *
2929
.\" -----------------------------------------------------------------
3030
.SH "NAME"
31-
nvme \- the dumb pci\-e storage utility
31+
nvme \- the NVMe storage command line interface utility (nvme\-cli)
3232
.SH "SYNOPSIS"
3333
.sp
34+
bulit\-in plugin:
35+
.sp
3436
.nf
3537
\fInvme\fR <command> <device> [<args>]
3638
.fi
39+
.sp
40+
extension plugins:
41+
.sp
42+
.nf
43+
\fInvme\fR <plugin> <command> <device> [<args>]
44+
.fi
3745
.SH "DESCRIPTION"
3846
.sp
39-
NVM\-Express is a fast, scalable host controller interface designed to address the needs for PCI Express based solid state drives\&.
47+
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)\&.
4048
.sp
4149
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\&.
4250
.SH "NVME COMMANDS"

Documentation/nvme.html

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -740,25 +740,32 @@ <h1>
740740
<h2>NAME</h2>
741741
<div class="sectionbody">
742742
<p>nvme -
743-
the dumb pci-e storage utility
743+
the NVMe storage command line interface utility (nvme-cli)
744744
</p>
745745
</div>
746746
</div>
747747
<div id="content">
748748
<div class="sect1">
749749
<h2 id="_synopsis">SYNOPSIS</h2>
750750
<div class="sectionbody">
751+
<div class="paragraph"><p>bulit-in plugin:</p></div>
751752
<div class="verseblock">
752753
<pre class="content"><em>nvme</em> &lt;command&gt; &lt;device&gt; [&lt;args&gt;]</pre>
753754
<div class="attribution">
754755
</div></div>
756+
<div class="paragraph"><p>extension plugins:</p></div>
757+
<div class="verseblock">
758+
<pre class="content"><em>nvme</em> &lt;plugin&gt; &lt;command&gt; &lt;device&gt; [&lt;args&gt;]</pre>
759+
<div class="attribution">
760+
</div></div>
755761
</div>
756762
</div>
757763
<div class="sect1">
758764
<h2 id="_description">DESCRIPTION</h2>
759765
<div class="sectionbody">
760766
<div class="paragraph"><p>NVM-Express is a fast, scalable host controller interface designed to
761-
address the needs for PCI Express based solid state drives.</p></div>
767+
address the needs for not only PCI Express based solid state drives, but
768+
also NVMe-oF(over fabrics).</p></div>
762769
<div class="paragraph"><p>This <em>nvme</em> program is a user space utility to provide standards compliant
763770
tooling for NVM-Express drives. It was made specifically for Linux as
764771
it relies on the IOCTLs defined by the mainline kernel driver.</p></div>
@@ -1183,7 +1190,7 @@ <h2 id="_nvme">NVME</h2>
11831190
<div id="footer">
11841191
<div id="footer-text">
11851192
Last updated
1186-
2018-09-04 00:00:12 KST
1193+
2019-07-24 00:35:34 KST
11871194
</div>
11881195
</div>
11891196
</body>

Documentation/nvme.txt

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,23 @@ nvme(1)
33

44
NAME
55
----
6-
nvme - the dumb pci-e storage utility
6+
nvme - the NVMe storage command line interface utility (nvme-cli)
77

88
SYNOPSIS
99
--------
10+
bulit-in plugin:
1011
[verse]
11-
'nvme' <command> <device> [<args>]
12+
'nvme' <command> <device> [<args>]
13+
14+
extension plugins:
15+
[verse]
16+
'nvme' <plugin> <command> <device> [<args>]
1217

1318
DESCRIPTION
1419
-----------
1520
NVM-Express is a fast, scalable host controller interface designed to
16-
address the needs for PCI Express based solid state drives.
21+
address the needs for not only PCI Express based solid state drives, but
22+
also NVMe-oF(over fabrics).
1723

1824
This 'nvme' program is a user space utility to provide standards compliant
1925
tooling for NVM-Express drives. It was made specifically for Linux as

0 commit comments

Comments
 (0)