Skip to content

Commit c231896

Browse files
[NVMe-ClI] Add Documentation files for clear-fw-activate-history command
1 parent 1ba85e5 commit c231896

3 files changed

Lines changed: 913 additions & 0 deletions

File tree

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
'\" t
2+
.\" Title: nvme-wdc-clear-fw-activate-history
3+
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4+
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
5+
.\" Date: 10/10/2019
6+
.\" Manual: NVMe Manual
7+
.\" Source: NVMe
8+
.\" Language: English
9+
.\"
10+
.TH "NVME\-WDC\-CLEAR\-FW" "1" "10/10/2019" "NVMe" "NVMe Manual"
11+
.\" -----------------------------------------------------------------
12+
.\" * Define some portability stuff
13+
.\" -----------------------------------------------------------------
14+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15+
.\" http://bugs.debian.org/507673
16+
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18+
.ie \n(.g .ds Aq \(aq
19+
.el .ds Aq '
20+
.\" -----------------------------------------------------------------
21+
.\" * set default formatting
22+
.\" -----------------------------------------------------------------
23+
.\" disable hyphenation
24+
.nh
25+
.\" disable justification (adjust text to left margin only)
26+
.ad l
27+
.\" -----------------------------------------------------------------
28+
.\" * MAIN CONTENT STARTS HERE *
29+
.\" -----------------------------------------------------------------
30+
.SH "NAME"
31+
nvme-wdc-clear-fw-activate-history \- Clears the firmware activate history table\&.
32+
.SH "SYNOPSIS"
33+
.sp
34+
.nf
35+
\fInvme wdc clear\-fw\-activate\-history\fR <device>
36+
.fi
37+
.SH "DESCRIPTION"
38+
.sp
39+
For the NVMe device given, sends the wdc vendor unique clear fw activate history command\&.
40+
.sp
41+
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
42+
.sp
43+
This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&.
44+
.SH "OPTIONS"
45+
.sp
46+
None
47+
.SH "EXAMPLES"
48+
.sp
49+
.RS 4
50+
.ie n \{\
51+
\h'-04'\(bu\h'+03'\c
52+
.\}
53+
.el \{\
54+
.sp -1
55+
.IP \(bu 2.3
56+
.\}
57+
Clears the firmware activate history table:
58+
.sp
59+
.if n \{\
60+
.RS 4
61+
.\}
62+
.nf
63+
# nvme wdc clear\-fw\-activate\-history /dev/nvme0
64+
.fi
65+
.if n \{\
66+
.RE
67+
.\}
68+
.RE
69+
.SH "NVME"
70+
.sp
71+
Part of the nvme\-user suite

0 commit comments

Comments
 (0)