From e0b186ca580433189352e27f33f9231e0dc8efe0 Mon Sep 17 00:00:00 2001 From: Minwoo Im Date: Tue, 1 Dec 2020 23:36:22 +0900 Subject: [PATCH] Add missing sub-command links from main man page 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 --- Documentation/cmds-main.txt | 35 +++++++++++++- Documentation/nvme.1 | 63 +++++++++++++++++++++++-- Documentation/nvme.html | 92 ++++++++++++++++++++++++++++++++++++- 3 files changed, 183 insertions(+), 7 deletions(-) diff --git a/Documentation/cmds-main.txt b/Documentation/cmds-main.txt index 824ca693..46df03dd 100644 --- a/Documentation/cmds-main.txt +++ b/Documentation/cmds-main.txt @@ -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 diff --git a/Documentation/nvme.1 b/Documentation/nvme.1 index 52aba381..295f5d19 100644 --- a/Documentation/nvme.1 +++ b/Documentation/nvme.1 @@ -1,13 +1,13 @@ '\" t .\" Title: nvme .\" Author: [see the "Authors" section] -.\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 10/20/2020 +.\" Generator: DocBook XSL Stylesheets v1.79.1 +.\" 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 diff --git a/Documentation/nvme.html b/Documentation/nvme.html index 5f9856c4..61531790 100644 --- a/Documentation/nvme.html +++ b/Documentation/nvme.html @@ -839,7 +839,15 @@ available, run "nvme help".

- F/W Activate + F/W Activate (in old version < 1.2) +

+
+
+nvme-fw-commit(1) +
+
+

+ F/W Commit (in > 1.2)

@@ -883,6 +891,14 @@ available, run "nvme help".

+nvme-changed-ns-list-log(1) +
+
+

+ Retrieve Changed Namespace List Log +

+
+
nvme-smart-log(1)
@@ -891,6 +907,14 @@ available, run "nvme help".

+nvme-ana-log(1) +
+
+

+ Retreive ANA(Asymmetric Namespace Access) Log +

+
+
nvme-endurance-log(1)
@@ -907,6 +931,14 @@ available, run "nvme help".

+nvme-self-test-log(1) +
+
+

+ Retrieve Device Self-test Log +

+
+
nvme-get-ns-id(1)
@@ -939,6 +971,22 @@ available, run "nvme help".

+nvme-id-nvmset(1) +
+
+

+ Identify NVM Set List +

+
+
+nvme-id-iocs(1) +
+
+

+ Identify I/O Command Set +

+
+
nvme-create-ns(1)
@@ -1011,6 +1059,30 @@ available, run "nvme help".

+nvme-list-subsys(1) +
+
+

+ List NVMe subsystems +

+
+
+nvme-reset(1) +
+
+

+ Reset a NVMe controller +

+
+
+nvme-device-self-test(1) +
+
+

+ Issue Device Self-test Command +

+
+
nvme-read(1)
@@ -1091,6 +1163,22 @@ available, run "nvme help".

+nvme-dsm(1) +
+
+

+ Issue Data Set Management Command +

+
+
+nvme-copy(1) +
+
+

+ Issue Simple Copy Command +

+
+
nvme-set-feature(1)
@@ -1190,7 +1278,7 @@ NVM-Express Site.

-- 2.50.1