diff options
Diffstat (limited to '')
| -rw-r--r-- | Documentation/nvme-fid-support-effects-log.1 (renamed from Documentation/nvme-wdc-clear-pcie-corr.1) | 48 |
1 files changed, 20 insertions, 28 deletions
diff --git a/Documentation/nvme-wdc-clear-pcie-corr.1 b/Documentation/nvme-fid-support-effects-log.1 index 6e5989d..b6b6fa6 100644 --- a/Documentation/nvme-wdc-clear-pcie-corr.1 +++ b/Documentation/nvme-fid-support-effects-log.1 @@ -1,13 +1,13 @@ '\" t -.\" Title: nvme-wdc-clear-pcie-corr +.\" Title: nvme-fid-support-effects-log .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/08/2019 +.\" Date: 11/11/2021 .\" Manual: NVMe Manual .\" Source: NVMe .\" Language: English .\" -.TH "NVME\-WDC\-CLEAR\-PC" "1" "01/08/2019" "NVMe" "NVMe Manual" +.TH "NVME\-FID\-SUPPORT\-" "1" "11/11/2021" "NVMe" "NVMe Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -28,44 +28,36 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -nvme-wdc-clear-pcie-corr \- Clears the pcie correctable errors field returned in the smart\-log\-add command\&. +nvme-fid-support-effects-log \- Send NVMe FID Support and Effects log, return result and structure .SH "SYNOPSIS" .sp .nf -\fInvme wdc clear\-pcie\-corr\fR <device> +\fInvme fid\-support\-effects\-log\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>] .fi .SH "DESCRIPTION" .sp -For the NVMe device given, sends the wdc vendor unique clear pcie correctable errors command\&. +For the NVMe device given, sends an FID Support and Effects log and provides the result and returned logstructure\&. .sp The <device> 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\&. +On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&. .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 PCIe Correctable Error Count field returned in the smart\-log\-add command: -.sp -.if n \{\ +.PP +\-o <format>, \-\-output\-format=<format> .RS 4 -.\} -.nf -# nvme wdc clear\-pcie\-corr /dev/nvme0 -.fi -.if n \{\ +Set the reporting format to +\fInormal\fR, +\fIjson\fR, or +\fIbinary\fR\&. Only one output format can be used at a time\&. .RE -.\} +.PP +\-H, \-\-human\-readable +.RS 4 +This option will parse and format many of the bit fields into human\-readable formats\&. .RE +.SH "EXAMPLES" +.sp +No examples yet\&. .SH "NVME" .sp Part of the nvme\-user suite |