From 352d3f74eea1db5dc2476f6f773846846b3dffdb Mon Sep 17 00:00:00 2001 From: Keith Busch Date: Fri, 19 Oct 2018 11:16:43 -0600 Subject: [PATCH] Re-gen documentation for new files Signed-off-by: Keith Busch --- Documentation/nvme-wdc-get-pfail-dump.1 | 116 +++ Documentation/nvme-wdc-get-pfail-dump.html | 835 +++++++++++++++++++++ 2 files changed, 951 insertions(+) create mode 100644 Documentation/nvme-wdc-get-pfail-dump.1 create mode 100644 Documentation/nvme-wdc-get-pfail-dump.html diff --git a/Documentation/nvme-wdc-get-pfail-dump.1 b/Documentation/nvme-wdc-get-pfail-dump.1 new file mode 100644 index 00000000..c36dad66 --- /dev/null +++ b/Documentation/nvme-wdc-get-pfail-dump.1 @@ -0,0 +1,116 @@ +'\" t +.\" Title: nvme-wdc-get-pfail-dump +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/19/2018 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-GET\-PFAI" "1" "10/19/2018" "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-get-pfail-dump \- Retrieve WDC device\*(Aqs pfail crash dump\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc get\-pfail\-dump\fR [\-\-output\-file=, \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends the WDC vendor unique pfail crash dump request and saves the result to file\&. In current implementation pfail crash dump is captured if it is present\&. On success it will save the dump in file with appropriate suffix\&. Note that this command will clear the available dump from the device on success\&. +.sp +The parameter is mandatory NVMe character device (ex: /dev/nvme0)\&. +.sp +This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-file= +.RS 4 +Output file; defaults to device serial number followed by "pfail_dump" suffix +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Gets the pfail crash dump from the device and saves to default file in current directory (e\&.g\&. STM00019F3F9_pfail_dump\&.bin): +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc get\-pfail\-dump /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Gets the pfail crash dump from the device and saves to defined file in current directory (e\&.g\&. testSTM00019F3F9_pfail_dump\&.bin): +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc get\-pfail\-dump /dev/nvme0 \-o test +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Gets the pfail crash dump from the device and saves to defined file with pathname (e\&.g\&. /tmp/testSTM00019F3F9_pfail_dump\&.bin): +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc get\-pfail\-dump /dev/nvme0 \-o /tmp/test +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-wdc-get-pfail-dump.html b/Documentation/nvme-wdc-get-pfail-dump.html new file mode 100644 index 00000000..1b440de3 --- /dev/null +++ b/Documentation/nvme-wdc-get-pfail-dump.html @@ -0,0 +1,835 @@ + + + + + +nvme-wdc-get-pfail-dump(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc get-pfail-dump <device> [--output-file=<FILE>, -o <FILE>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends the WDC vendor unique pfail crash dump +request and saves the result to file. In current implementation pfail crash +dump is captured if it is present. On success it will save the dump in file +with appropriate suffix. Note that this command will clear the available +dump from the device on success.

+

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

+

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

+
+
+
+

OPTIONS

+
+
+
+-o <FILE> +
+
+--output-file=<FILE> +
+
+

+ Output file; defaults to device serial number followed by "pfail_dump" suffix +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Gets the pfail crash dump from the device and saves to default file in current directory +(e.g. STM00019F3F9_pfail_dump.bin): +

    +
    +
    +
    # nvme wdc get-pfail-dump /dev/nvme0
    +
    +
  • +
  • +

    +Gets the pfail crash dump from the device and saves to defined file in current directory +(e.g. testSTM00019F3F9_pfail_dump.bin): +

    +
    +
    +
    # nvme wdc get-pfail-dump /dev/nvme0 -o test
    +
    +
  • +
  • +

    +Gets the pfail crash dump from the device and saves to defined file with pathname (e.g. /tmp/testSTM00019F3F9_pfail_dump.bin): +

    +
    +
    +
    # nvme wdc get-pfail-dump /dev/nvme0 -o /tmp/test
    +
    +
  • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+

+ + + -- 2.50.1