From: Jeff Lien Date: Fri, 21 Feb 2020 16:48:19 +0000 (-0600) Subject: Add documentation files for new wdc plugin command - vs-drive-info X-Git-Tag: v1.11~27 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=032cc2ef3c58a54d42671e5295fbf1287b1feaba;p=users%2Fhch%2Fnvme-cli.git Add documentation files for new wdc plugin command - vs-drive-info --- diff --git a/Documentation/nvme-wdc-vs-drive-info.1 b/Documentation/nvme-wdc-vs-drive-info.1 new file mode 100644 index 0000000..abb71c2 --- /dev/null +++ b/Documentation/nvme-wdc-vs-drive-info.1 @@ -0,0 +1,58 @@ +'\" t +.\" Title: nvme-wdc-vs-drive-info +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 02/21/2020 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-VS\-DRIVE" "1" "02/21/2020" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-wdc-vs-drive-info \- Send the NVMe WDC vs\-drive\-info command, return result +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc vs\-drive\-info\fR +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, send the unique WDC vs\-drive\-info command and provide the additional drive information\&. +.sp +The parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0)\&. +.sp +This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. +.sp +On success it returns 0, error code otherwise\&. +.SH "OUTPUT EXPLANATION" +.sp +There are 2 fields returned from this command: +.sp +Drive HW Revision +.sp +FTL Unit Size +.SH "EXAMPLE" +.sp +# nvme wdc vs\-drive\-info /dev/nvme0 +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-wdc-vs-drive-info.html b/Documentation/nvme-wdc-vs-drive-info.html new file mode 100644 index 0000000..0013ea6 --- /dev/null +++ b/Documentation/nvme-wdc-vs-drive-info.html @@ -0,0 +1,794 @@ + + + + + +nvme-wdc-vs-drive-info(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc vs-drive-info <device>
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send the unique WDC vs-drive-info command and +provide the additional drive information.

+

The <device> parameter is mandatory and must be the NVMe character +device (ex: /dev/nvme0).

+

This will only work on WDC devices supporting this feature. +Results for any other device are undefined.

+

On success it returns 0, error code otherwise.

+
+
+
+

Output Explanation

+
+

There are 2 fields returned from this command:

+

Drive HW Revision

+

FTL Unit Size

+
+
+
+

EXAMPLE

+
+

# nvme wdc vs-drive-info /dev/nvme0

+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-vs-drive-info.txt b/Documentation/nvme-wdc-vs-drive-info.txt new file mode 100644 index 0000000..15e7c6b --- /dev/null +++ b/Documentation/nvme-wdc-vs-drive-info.txt @@ -0,0 +1,42 @@ +nvme-wdc-vs-drive-info(1) +========================= + +NAME +---- +nvme-wdc-vs-drive-info - Send the NVMe WDC vs-drive-info command, return result + +SYNOPSIS +-------- +[verse] +'nvme wdc vs-drive-info' + +DESCRIPTION +----------- +For the NVMe device given, send the unique WDC vs-drive-info command and +provide the additional drive information. + +The parameter is mandatory and must be the NVMe character +device (ex: /dev/nvme0). + +This will only work on WDC devices supporting this feature. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +Output Explanation +------------------ +There are 2 fields returned from this command: + +Drive HW Revision + +FTL Unit Size + + +EXAMPLE +-------- +# nvme wdc vs-drive-info /dev/nvme0 + + +NVME +---- +Part of the nvme-user suite.