From: Minwoo Im <minwoo.im.dev@gmail.com>
Date: Tue, 23 Jul 2019 15:34:24 +0000 (+0900)
Subject: doc: add extension plugins' command format
X-Git-Tag: v1.9~31^2
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=bda663a0d0859023ed09d2b7e2df9b4c29a3c363;p=users%2Fsagi%2Fnvme-cli.git

doc: add extension plugins' command format

If user wants to take a extension plugin, then it should be like:
	nvme <plugin> <command> <device> [<args>]

Signed-off-by: Minwoo Im <minwoo.im.dev@gmail.com>
---

diff --git a/Documentation/nvme.1 b/Documentation/nvme.1
index 0b2a8bad..f8d10c58 100644
--- a/Documentation/nvme.1
+++ b/Documentation/nvme.1
@@ -31,9 +31,17 @@
 nvme \- the NVMe storage command line interface utility (nvme\-cli)
 .SH "SYNOPSIS"
 .sp
+bulit\-in plugin:
+.sp
 .nf
 \fInvme\fR <command> <device> [<args>]
 .fi
+.sp
+extension plugins:
+.sp
+.nf
+\fInvme\fR <plugin> <command> <device> [<args>]
+.fi
 .SH "DESCRIPTION"
 .sp
 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)\&.
diff --git a/Documentation/nvme.html b/Documentation/nvme.html
index bad6f1c1..c2ee5f0a 100644
--- a/Documentation/nvme.html
+++ b/Documentation/nvme.html
@@ -748,10 +748,16 @@ nvme(1) Manual Page
 <div class="sect1">
 <h2 id="_synopsis">SYNOPSIS</h2>
 <div class="sectionbody">
+<div class="paragraph"><p>bulit-in plugin:</p></div>
 <div class="verseblock">
 <pre class="content"><em>nvme</em> &lt;command&gt; &lt;device&gt; [&lt;args&gt;]</pre>
 <div class="attribution">
 </div></div>
+<div class="paragraph"><p>extension plugins:</p></div>
+<div class="verseblock">
+<pre class="content"><em>nvme</em> &lt;plugin&gt; &lt;command&gt; &lt;device&gt; [&lt;args&gt;]</pre>
+<div class="attribution">
+</div></div>
 </div>
 </div>
 <div class="sect1">
diff --git a/Documentation/nvme.txt b/Documentation/nvme.txt
index 0092be79..e8ead9ea 100644
--- a/Documentation/nvme.txt
+++ b/Documentation/nvme.txt
@@ -7,8 +7,13 @@ nvme - the NVMe storage command line interface utility (nvme-cli)
 
 SYNOPSIS
 --------
+bulit-in plugin:
 [verse]
-'nvme' <command> <device> [<args>] 
+'nvme' <command> <device> [<args>]
+
+extension plugins:
+[verse]
+'nvme' <plugin> <command> <device> [<args>]
 
 DESCRIPTION
 -----------