From: Jeff Lien Date: Fri, 11 Oct 2019 21:39:50 +0000 (-0500) Subject: [NVMe-ClI] Add Documentation files for clear-fw-activate-history command X-Git-Tag: v1.10~61^2 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=c2318963c816e44be599e0bdbc74372273b68099;p=users%2Fhch%2Fnvme-cli.git [NVMe-ClI] Add Documentation files for clear-fw-activate-history command --- diff --git a/Documentation/nvme-wdc-clear-fw-activate-history.1 b/Documentation/nvme-wdc-clear-fw-activate-history.1 new file mode 100644 index 0000000..eac11b7 --- /dev/null +++ b/Documentation/nvme-wdc-clear-fw-activate-history.1 @@ -0,0 +1,71 @@ +'\" t +.\" Title: nvme-wdc-clear-fw-activate-history +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 +.\" Date: 10/10/2019 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-CLEAR\-FW" "1" "10/10/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-clear-fw-activate-history \- Clears the firmware activate history table\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc clear\-fw\-activate\-history\fR +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, sends the wdc vendor unique clear fw activate history command\&. +.sp +The parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. +.sp +This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&. +.SH "OPTIONS" +.sp +None +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Clears the firmware activate history table: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc clear\-fw\-activate\-history /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite diff --git a/Documentation/nvme-wdc-clear-fw-activate-history.html b/Documentation/nvme-wdc-clear-fw-activate-history.html new file mode 100644 index 0000000..352bec7 --- /dev/null +++ b/Documentation/nvme-wdc-clear-fw-activate-history.html @@ -0,0 +1,802 @@ + + + + + +nvme-wdc-clear-fw-activate-history(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc clear-fw-activate-history <device>
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, sends the wdc vendor unique clear fw activate +history command.

+

The <device> parameter is mandatory and may be either the NVMe +character device (ex: /dev/nvme0), or a namespace block device (ex: +/dev/nvme0n1).

+

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

+
+
+
+

OPTIONS

+
+

None

+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Clears the firmware activate history table: +

    +
    +
    +
    # nvme wdc clear-fw-activate-history /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-clear-fw-activate-history.txt b/Documentation/nvme-wdc-clear-fw-activate-history.txt new file mode 100644 index 0000000..b10ac2f --- /dev/null +++ b/Documentation/nvme-wdc-clear-fw-activate-history.txt @@ -0,0 +1,40 @@ +nvme-wdc-clear-fw-activate-history(1) +===================================== + +NAME +---- +nvme-wdc-clear-fw-activate-history - Clears the firmware activate history table. + +SYNOPSIS +-------- +[verse] +'nvme wdc clear-fw-activate-history' + +DESCRIPTION +----------- +For the NVMe device given, sends the wdc vendor unique clear fw activate +history command. + +The parameter is mandatory and may be either the NVMe +character device (ex: /dev/nvme0), or a namespace block device (ex: +/dev/nvme0n1). + +This will only work on WDC devices supporting this feature. +Results for any other device are undefined. + +OPTIONS +------- +None + +EXAMPLES +-------- +* Clears the firmware activate history table: ++ +------------ +# nvme wdc clear-fw-activate-history /dev/nvme0 +------------ + + +NVME +---- +Part of the nvme-user suite