summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-wdc-clear-pcie-corr.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-wdc-clear-pcie-corr.1 (renamed from Documentation/nvme-lnvm-id-ns.1)47
1 files changed, 15 insertions, 32 deletions
diff --git a/Documentation/nvme-lnvm-id-ns.1 b/Documentation/nvme-wdc-clear-pcie-corr.1
index 32e7029..6e5989d 100644
--- a/Documentation/nvme-lnvm-id-ns.1
+++ b/Documentation/nvme-wdc-clear-pcie-corr.1
@@ -1,13 +1,13 @@
'\" t
-.\" Title: nvme-lnvm-id-ns
+.\" Title: nvme-wdc-clear-pcie-corr
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 11/11/2021
+.\" Date: 01/08/2019
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LNVM\-ID\-NS" "1" "11/11/2021" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CLEAR\-PC" "1" "01/08/2019" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,39 +28,22 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-nvme-lnvm-id-ns \- Identify Geometry for LightNVM NVMe device
+nvme-wdc-clear-pcie-corr \- Clears the pcie correctable errors field returned in the smart\-log\-add command\&.
.SH "SYNOPSIS"
.sp
.nf
-\fInvme lnvm\-id\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-force | \-f]
- [\-\-raw\-binary | \-b]
- [\-\-human\-readable | \-H]
+\fInvme wdc clear\-pcie\-corr\fR <device>
.fi
.SH "DESCRIPTION"
.sp
-Send an Identify Geometry command to the given LightNVM device, returns properties of the specified namespace in either human\-readable or binary format\&.
+For the NVMe device given, sends the wdc vendor unique clear pcie correctable errors command\&.
+.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\&.
.SH "OPTIONS"
-.PP
-\-\-namespace\-id=<nsid>, \-n <nsid>
-.RS 4
-Retrieve the geometry from the selected namespace\&.
-.RE
-.PP
-\-\-force, \-f
-.RS 4
-Try to read the data and assume it is a LightNVM device
-.RE
-.PP
-\-\-raw\-binary, \-b
-.RS 4
-Output the raw output
-.RE
-.PP
-\-\-human\-readable, \-H
-.RS 4
-Output the status in human readable format
-.RE
+.sp
+None
.SH "EXAMPLES"
.sp
.RS 4
@@ -71,18 +54,18 @@ Output the status in human readable format
.sp -1
.IP \(bu 2.3
.\}
-Retrieve the geometry from nvme0
-.RE
+Clears the PCIe Correctable Error Count field returned in the smart\-log\-add command:
.sp
.if n \{\
.RS 4
.\}
.nf
-# nvme lnvm\-id\-ns /dev/nvme0 \-n 1
+# nvme wdc clear\-pcie\-corr /dev/nvme0
.fi
.if n \{\
.RE
.\}
+.RE
.SH "NVME"
.sp
Part of the nvme\-user suite