From: Tokunori Ikegami <ikegami.t@gmail.com>
Date: Tue, 11 Apr 2023 16:03:50 +0000 (+0900)
Subject: doc: Add clear-pcie-correctable-error-counters command documentation
X-Git-Tag: v2.5~182
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=d7d6989bdf8f991e95ee502e1268c62d2b08b84f;p=users%2Fsagi%2Fnvme-cli.git

doc: Add clear-pcie-correctable-error-counters command documentation

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
---

diff --git a/Documentation/meson.build b/Documentation/meson.build
index de6347e7..f555aea4 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -88,6 +88,7 @@ adoc_sources = [
   'nvme-ocp-latency-monitor-log',
   'nvme-ocp-smart-add-log',
   'nvme-ocp-clear-fw-activate-history',
+  'nvme-ocp-clear-pcie-correctable-error-counters',
   'nvme-ocp-eol-plp-failure-mode',
   'nvme-persistent-event-log',
   'nvme-pred-lat-event-agg-log',
diff --git a/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt
new file mode 100644
index 00000000..92cd1487
--- /dev/null
+++ b/Documentation/nvme-ocp-clear-pcie-correctable-error-counters.txt
@@ -0,0 +1,49 @@
+nvme-ocp-clear-pcie-correctable-error-counters(1)
+=================================================
+
+NAME
+----
+nvme-ocp-clear-pcie-correctable-error-counters - Clear PCIe correctable error counters
+
+SYNOPSIS
+--------
+[verse]
+'nvme ocp clear-pcie-correctable-error-counters' <device> [--no-uuid | -n]
+
+DESCRIPTION
+-----------
+For the NVMe device given, Clear PCIe correctable error counters.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).
+
+This command with no option added, will try to automatically detect the
+parameters of the command. This will work successfully or fail gracefully for
+devices supporting UUID for Vendor Specific Information (NVMe 1.4 or later,
+OCP 2.0 requires NVMe 1.4b). For devices that do not support OCP 2.0 the
+command will fail gracefully, unless the --no-uuid option is provided.
+
+For OCP 1.0 devices (before NVMe 1.4) the --no-uuid option is required.
+When --no-uuid option is provided, results for devices before NVMe 1.4 without
+OCP support are undefined.
+
+On success it returns 0, error code otherwise.
+
+OPTIONS
+-------
+-n::
+--no-uuid::
+	Do not try to automatically detect UUID index for this command (required
+        for old OCP 1.0 support)
+
+EXAMPLES
+--------
+* Clears PCIe correctable error counters Log for the device:
++
+------------
+# nvme ocp clear-pcie-correctable-error-counters /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.