]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
Add missing sub-command links from main man page
authorMinwoo Im <minwoo.im.dev@gmail.com>
Tue, 1 Dec 2020 14:36:22 +0000 (23:36 +0900)
committerKeith Busch <kbusch@kernel.org>
Tue, 1 Dec 2020 15:23:12 +0000 (08:23 -0700)
This patch adds missing subcommands to the main man page.

Issue: https://github.com/linux-nvme/nvme-cli/issues/793
Signed-off-by: Minwoo Im <minwoo.im.dev@gmail.com>
Documentation/cmds-main.txt
Documentation/nvme.1
Documentation/nvme.html

index 824ca6933faf3bba7fcb815b3ce8b12e8d55b57a..46df03ddfc8a91fd0acc8e47426be74f82ec480c 100644 (file)
@@ -17,7 +17,10 @@ linknvme:nvme-format[1]::
        Format namespace(s)
 
 linknvme:nvme-fw-activate[1]::
-       F/W Activate
+       F/W Activate (in old version < 1.2)
+
+linknvme:nvme-fw-commit[1]::
+       F/W Commit (in > 1.2)
 
 linknvme:nvme-fw-download[1]::
        F/W Download
@@ -34,15 +37,24 @@ linknvme:nvme-get-log[1]::
 linknvme:nvme-telemetry-log[1]::
        Telemetry Host-Initiated Log
 
+linknvme:nvme-changed-ns-list-log[1]::
+       Retrieve Changed Namespace List Log
+
 linknvme:nvme-smart-log[1]::
        Retrieve Smart Log
 
+linknvme:nvme-ana-log[1]::
+       Retreive ANA(Asymmetric Namespace Access) Log
+
 linknvme:nvme-endurance-log[1]::
        Retrieve endurance Log
 
 linknvme:nvme-effects-log[1]::
        Retrieve effects Log
 
+linknvme:nvme-self-test-log[1]::
+       Retrieve Device Self-test Log
+
 linknvme:nvme-get-ns-id[1]::
        Retrieve namespace identifier
 
@@ -55,6 +67,12 @@ linknvme:nvme-id-ctrl[1]::
 linknvme:nvme-id-ns[1]::
        Identify Namespace
 
+linknvme:nvme-id-nvmset[1]::
+       Identify NVM Set List
+
+linknvme:nvme-id-iocs[1]::
+       Identify I/O Command Set
+
 linknvme:nvme-create-ns[1]::
        Create a new namespace
 
@@ -82,6 +100,15 @@ linknvme:nvme-list[1]::
 linknvme:nvme-list-ctrl[1]::
        List controller in NVMe subsystem
 
+linknvme:nvme-list-subsys[1]::
+       List NVMe subsystems
+
+linknvme:nvme-reset[1]::
+       Reset a NVMe controller
+
+linknvme:nvme-device-self-test[1]::
+       Issue Device Self-test Command
+
 linknvme:nvme-read[1]::
        Issue IO Read Command
 
@@ -112,6 +139,12 @@ linknvme:nvme-security-recv[1]::
 linknvme:nvme-security-send[1]::
        Security Send
 
+linknvme:nvme-dsm[1]::
+       Issue Data Set Management Command
+
+linknvme:nvme-copy[1]::
+       Issue Simple Copy Command
+
 linknvme:nvme-set-feature[1]::
        Set Feature
 
index 52aba381a4aa236f23b65a17c71e4d62d5d18932..295f5d1970a380bfb597fa12fb889283bdc44c26 100644 (file)
@@ -1,13 +1,13 @@
 '\" t
 .\"     Title: nvme
 .\"    Author: [see the "Authors" section]
-.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\"      Date: 10/20/2020
+.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
+.\"      Date: 12/01/2020
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME" "1" "10/20/2020" "NVMe" "NVMe Manual"
+.TH "NVME" "1" "12/01/2020" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -85,7 +85,12 @@ Format namespace(s)
 .PP
 \fBnvme-fw-activate\fR(1)
 .RS 4
-F/W Activate
+F/W Activate (in old version < 1\&.2)
+.RE
+.PP
+\fBnvme-fw-commit\fR(1)
+.RS 4
+F/W Commit (in > 1\&.2)
 .RE
 .PP
 \fBnvme-fw-download\fR(1)
@@ -113,11 +118,21 @@ Generic Get Log
 Telemetry Host\-Initiated Log
 .RE
 .PP
+\fBnvme-changed-ns-list-log\fR(1)
+.RS 4
+Retrieve Changed Namespace List Log
+.RE
+.PP
 \fBnvme-smart-log\fR(1)
 .RS 4
 Retrieve Smart Log
 .RE
 .PP
+\fBnvme-ana-log\fR(1)
+.RS 4
+Retreive ANA(Asymmetric Namespace Access) Log
+.RE
+.PP
 \fBnvme-endurance-log\fR(1)
 .RS 4
 Retrieve endurance Log
@@ -128,6 +143,11 @@ Retrieve endurance Log
 Retrieve effects Log
 .RE
 .PP
+\fBnvme-self-test-log\fR(1)
+.RS 4
+Retrieve Device Self\-test Log
+.RE
+.PP
 \fBnvme-get-ns-id\fR(1)
 .RS 4
 Retrieve namespace identifier
@@ -148,6 +168,16 @@ Identify Controller
 Identify Namespace
 .RE
 .PP
+\fBnvme-id-nvmset\fR(1)
+.RS 4
+Identify NVM Set List
+.RE
+.PP
+\fBnvme-id-iocs\fR(1)
+.RS 4
+Identify I/O Command Set
+.RE
+.PP
 \fBnvme-create-ns\fR(1)
 .RS 4
 Create a new namespace
@@ -193,6 +223,21 @@ List all nvme controllers
 List controller in NVMe subsystem
 .RE
 .PP
+\fBnvme-list-subsys\fR(1)
+.RS 4
+List NVMe subsystems
+.RE
+.PP
+\fBnvme-reset\fR(1)
+.RS 4
+Reset a NVMe controller
+.RE
+.PP
+\fBnvme-device-self-test\fR(1)
+.RS 4
+Issue Device Self\-test Command
+.RE
+.PP
 \fBnvme-read\fR(1)
 .RS 4
 Issue IO Read Command
@@ -243,6 +288,16 @@ Security Receive
 Security Send
 .RE
 .PP
+\fBnvme-dsm\fR(1)
+.RS 4
+Issue Data Set Management Command
+.RE
+.PP
+\fBnvme-copy\fR(1)
+.RS 4
+Issue Simple Copy Command
+.RE
+.PP
 \fBnvme-set-feature\fR(1)
 .RS 4
 Set Feature
index 5f9856c4927db588e15fdb8e02e3902858d711d4..61531790d3caecc412ae3083a0134585d052568d 100644 (file)
@@ -839,7 +839,15 @@ available, run "nvme help".</p></div>
 </dt>\r
 <dd>\r
 <p>\r
-        F/W Activate\r
+        F/W Activate (in old version &lt; 1.2)\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+<a href="nvme-fw-commit.html">nvme-fw-commit(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        F/W Commit (in &gt; 1.2)\r
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
@@ -883,6 +891,14 @@ available, run "nvme help".</p></div>
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+<a href="nvme-changed-ns-list-log.html">nvme-changed-ns-list-log(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Retrieve Changed Namespace List Log\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 <a href="nvme-smart-log.html">nvme-smart-log(1)</a>\r
 </dt>\r
 <dd>\r
@@ -891,6 +907,14 @@ available, run "nvme help".</p></div>
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+<a href="nvme-ana-log.html">nvme-ana-log(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Retreive ANA(Asymmetric Namespace Access) Log\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 <a href="nvme-endurance-log.html">nvme-endurance-log(1)</a>\r
 </dt>\r
 <dd>\r
@@ -907,6 +931,14 @@ available, run "nvme help".</p></div>
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+<a href="nvme-self-test-log.html">nvme-self-test-log(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Retrieve Device Self-test Log\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 <a href="nvme-get-ns-id.html">nvme-get-ns-id(1)</a>\r
 </dt>\r
 <dd>\r
@@ -939,6 +971,22 @@ available, run "nvme help".</p></div>
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+<a href="nvme-id-nvmset.html">nvme-id-nvmset(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Identify NVM Set List\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+<a href="nvme-id-iocs.html">nvme-id-iocs(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Identify I/O Command Set\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 <a href="nvme-create-ns.html">nvme-create-ns(1)</a>\r
 </dt>\r
 <dd>\r
@@ -1011,6 +1059,30 @@ available, run "nvme help".</p></div>
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+<a href="nvme-list-subsys.html">nvme-list-subsys(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        List NVMe subsystems\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+<a href="nvme-reset.html">nvme-reset(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Reset a NVMe controller\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+<a href="nvme-device-self-test.html">nvme-device-self-test(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Issue Device Self-test Command\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 <a href="nvme-read.html">nvme-read(1)</a>\r
 </dt>\r
 <dd>\r
@@ -1091,6 +1163,22 @@ available, run "nvme help".</p></div>
 </p>\r
 </dd>\r
 <dt class="hdlist1">\r
+<a href="nvme-dsm.html">nvme-dsm(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Issue Data Set Management Command\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+<a href="nvme-copy.html">nvme-copy(1)</a>\r
+</dt>\r
+<dd>\r
+<p>\r
+        Issue Simple Copy Command\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
 <a href="nvme-set-feature.html">nvme-set-feature(1)</a>\r
 </dt>\r
 <dd>\r
@@ -1190,7 +1278,7 @@ NVM-Express Site</a>.</p></div>
 <div id="footer">\r
 <div id="footer-text">\r
 Last updated\r
- 2020-02-15 08:33:28 JST\r
+ 2020-07-11 13:12:07 KST\r
 </div>\r
 </div>\r
 </body>\r