From 652dc654c813e5a927e90c906073e50ac7b450f2 Mon Sep 17 00:00:00 2001 From: Keith Busch Date: Wed, 27 Feb 2019 15:52:13 -0700 Subject: [PATCH] Generate new documentation Signed-off-by: Keith Busch --- Documentation/nvme-wdc-vs-nand-stats.1 | 78 +++ Documentation/nvme-wdc-vs-nand-stats.html | 817 ++++++++++++++++++++++ 2 files changed, 895 insertions(+) create mode 100644 Documentation/nvme-wdc-vs-nand-stats.1 create mode 100644 Documentation/nvme-wdc-vs-nand-stats.html diff --git a/Documentation/nvme-wdc-vs-nand-stats.1 b/Documentation/nvme-wdc-vs-nand-stats.1 new file mode 100644 index 00000000..04e1bbb3 --- /dev/null +++ b/Documentation/nvme-wdc-vs-nand-stats.1 @@ -0,0 +1,78 @@ +'\" t +.\" Title: nvme-wdc-vs-nand-stats +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 02/27/2019 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-VS\-NAND\" "1" "02/27/2019" "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-nand-stats \- Send NVMe WDC vs\-nand\-stats Vendor Unique Command, return result +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc vs\-nand\-stats\fR [\-\-output\-format= \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, send a Vendor Unique WDC vs\-nand\-stats command and output the NAND statistics\&. The \-\-output\-format option will format the output as specified\&. +.sp +The parameter is mandatory and may be either 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 the NAND statistics, error code otherwise\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR, or +\fIjson\fR\&. Only one output format can be used at a time\&. Default is normal\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Has the program issue WDC vs\-nand\-stats Vendor Unique Command : +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc vs\-nand\-stats /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-wdc-vs-nand-stats.html b/Documentation/nvme-wdc-vs-nand-stats.html new file mode 100644 index 00000000..97c436dd --- /dev/null +++ b/Documentation/nvme-wdc-vs-nand-stats.html @@ -0,0 +1,817 @@ + + + + + +nvme-wdc-vs-nand-stats(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc vs-nand-stats <device> [--output-format=<normal|json> -o <normal|json>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, send a Vendor Unique WDC vs-nand-stats command and +output the NAND statistics. The --output-format option will format the output as +specified.

+

The <device> parameter is mandatory and may be either 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 the NAND statistics, error code otherwise.

+
+
+
+

OPTIONS

+
+
+
+-o <format> +
+
+--output-format=<format> +
+
+

+ Set the reporting format to normal, or + json. Only one output format can be used at a time. + Default is normal. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Has the program issue WDC vs-nand-stats Vendor Unique Command : +

    +
    +
    +
    # nvme wdc vs-nand-stats /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + -- 2.50.1