]> www.infradead.org Git - users/sagi/nvme-cli.git/commitdiff
Update documentation files for vs-smart-add-log change
authorJeff Lien <jeff.lien@wdc.com>
Fri, 22 Oct 2021 17:47:08 +0000 (12:47 -0500)
committerDaniel Wagner <dwagner@suse.de>
Mon, 15 Nov 2021 11:06:29 +0000 (12:06 +0100)
Signed-off-by: Jeff Lien <jeff.lien@wdc.com>
Documentation/nvme-wdc-vs-smart-add-log.1
Documentation/nvme-wdc-vs-smart-add-log.html
Documentation/nvme-wdc-vs-smart-add-log.txt

index 4e9c1868ec62e99eccbf60c8e2c11bb7b2be9bef..143cf6244f14b82372b289afbf719a9007aa868d 100644 (file)
@@ -2,12 +2,12 @@
 .\"     Title: nvme-wdc-vs-smart-add-log
 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\"      Date: 10/20/2020
+.\"      Date: 10/22/2021
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-WDC\-VS\-SMART" "1" "10/20/2020" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-SMART" "1" "10/22/2021" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -32,8 +32,11 @@ nvme-wdc-vs-smart-add-log \- Send NVMe WDC vs\-smart\-add\-log Vendor Unique Com
 .SH "SYNOPSIS"
 .sp
 .nf
-\fInvme wdc vs\-smart\-add\-log\fR <device> [\-\-interval=<NUM>, \-i <NUM>] [\-\-output\-format=<normal|json> \-o <normal|json>]
-    [\-\-log\-page\-version=<NUM>, \-l <NUM>] [\-\-log\-page\-mask=<LIST>, \-p <LIST>]
+\fInvme wdc vs\-smart\-add\-log\fR <device> [\-\-interval=<NUM>, \-i <NUM>]
+                        [\-\-output\-format=<normal|json> \-o <normal|json>]
+                        [\-\-log\-page\-version=<NUM>, \-l <NUM>]
+                        [\-\-log\-page\-mask=<LIST>, \-p <LIST>]
+                        [\-\-namespace\-id=<nsid> | \-n <nsid>]
 .fi
 .SH "DESCRIPTION"
 .sp
@@ -67,6 +70,11 @@ Log Page Version: 0 = vendor, 1 = WDC\&. This parameter is only valid for the 0x
 .RS 4
 Supply a comma separated list of desired log pages to display\&. The possible values are 0xc0, 0xc1, 0xca, 0xd0\&. Note: Not all pages are supported on all drives\&. The default is to display all supported log pages\&.
 .RE
+.PP
+\-n <nsid>, \-\-namespace\-id=<nsid>
+.RS 4
+Sets the command\(cqs nsid value to the given nsid\&. Defaults to 0xffffffff if not given\&. This option may not affect anything depending on the log page, which may or may not be specific to a namespace\&.
+.RE
 .sp
 Valid Interval values and description :\-
 .TS
index 29cf0fa442323d8c20b1811850634c7cf550c226..b61990a6ab89b9a2b77938f413f0030d3baf8d9d 100644 (file)
@@ -749,8 +749,11 @@ nvme-wdc-vs-smart-add-log(1) Manual Page
 <h2 id="_synopsis">SYNOPSIS</h2>\r
 <div class="sectionbody">\r
 <div class="verseblock">\r
-<pre class="content"><em>nvme wdc vs-smart-add-log</em> &lt;device&gt; [--interval=&lt;NUM&gt;, -i &lt;NUM&gt;] [--output-format=&lt;normal|json&gt; -o &lt;normal|json&gt;]\r
-    [--log-page-version=&lt;NUM&gt;, -l &lt;NUM&gt;] [--log-page-mask=&lt;LIST&gt;, -p &lt;LIST&gt;]</pre>\r
+<pre class="content"><em>nvme wdc vs-smart-add-log</em> &lt;device&gt; [--interval=&lt;NUM&gt;, -i &lt;NUM&gt;]\r
+                        [--output-format=&lt;normal|json&gt; -o &lt;normal|json&gt;]\r
+                        [--log-page-version=&lt;NUM&gt;, -l &lt;NUM&gt;]\r
+                        [--log-page-mask=&lt;LIST&gt;, -p &lt;LIST&gt;]\r
+                        [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]</pre>\r
 <div class="attribution">\r
 </div></div>\r
 </div>\r
@@ -822,6 +825,20 @@ Results for any other device are undefined.</p></div>
     The default is to display all supported log pages.\r
 </p>\r
 </dd>\r
+<dt class="hdlist1">\r
+-n &lt;nsid&gt;\r
+</dt>\r
+<dt class="hdlist1">\r
+--namespace-id=&lt;nsid&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+        Sets the command&#8217;s nsid value to the given nsid. Defaults to\r
+        0xffffffff if not given. This option may not affect anything\r
+        depending on the log page, which may or may not be specific to\r
+        a namespace.\r
+</p>\r
+</dd>\r
 </dl></div>\r
 <div class="paragraph"><p>Valid Interval values and description :-</p></div>\r
 <div class="tableblock">\r
@@ -910,7 +927,7 @@ Has the program issue WDC vs-smart-add-log Vendor Unique Command for 0xC0 and 0x
 <div id="footer">\r
 <div id="footer-text">\r
 Last updated\r
- 2020-08-06 15:54:37 PDT\r
+ 2021-10-22 12:29:47 CDT\r
 </div>\r
 </div>\r
 </body>\r
index 96b55c5fa1680525ac820e24a10d11134d139f99..7de1ac8ffbb3387d2e22d795d994473517dd8555 100644 (file)
@@ -8,8 +8,11 @@ nvme-wdc-vs-smart-add-log - Send NVMe WDC vs-smart-add-log Vendor Unique Command
 SYNOPSIS
 --------
 [verse]
-'nvme wdc vs-smart-add-log' <device> [--interval=<NUM>, -i <NUM>] [--output-format=<normal|json> -o <normal|json>]
-    [--log-page-version=<NUM>, -l <NUM>] [--log-page-mask=<LIST>, -p <LIST>] 
+'nvme wdc vs-smart-add-log' <device> [--interval=<NUM>, -i <NUM>] 
+                       [--output-format=<normal|json> -o <normal|json>]
+                       [--log-page-version=<NUM>, -l <NUM>] 
+                       [--log-page-mask=<LIST>, -p <LIST>] 
+                       [--namespace-id=<nsid> | -n <nsid>]
 
 DESCRIPTION
 -----------
@@ -49,6 +52,13 @@ OPTIONS
     Note: Not all pages are supported on all drives.  
     The default is to display all supported log pages.  
 
+-n <nsid>::
+--namespace-id=<nsid>::
+       Sets the command's nsid value to the given nsid. Defaults to
+       0xffffffff if not given. This option may not affect anything
+       depending on the log page, which may or may not be specific to
+       a namespace.
+
 Valid Interval values and description :-
 
 [cols="2*", frame="topbot", align="center", options="header"]