From 1cc8413aaf5f8fa6595aece1933462c096e88639 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Mon, 29 Apr 2024 06:41:05 +0200
Subject: Adding upstream version 2.4+really2.3.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 Documentation/nvme-wdc-get-error-recovery-log.txt | 48 +++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 Documentation/nvme-wdc-get-error-recovery-log.txt

(limited to 'Documentation/nvme-wdc-get-error-recovery-log.txt')

diff --git a/Documentation/nvme-wdc-get-error-recovery-log.txt b/Documentation/nvme-wdc-get-error-recovery-log.txt
new file mode 100644
index 0000000..2ad3605
--- /dev/null
+++ b/Documentation/nvme-wdc-get-error-recovery-log.txt
@@ -0,0 +1,48 @@
+nvme-wdc-get-error-recovery-log(1)
+==================================
+
+NAME
+----
+nvme-wdc-get-error-recovery-log - Send NVMe WDC get-error-recovery-log plugin 
+								  command, return parsed log output
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc get-error-recovery-log' <device> [--output-format=<normal|json> 
+-o <normal|json>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, send a WDC plugin get-error-recovery-log command 
+and output the error recovery log data. The --output-format option will format
+the output as specified.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0).
+
+This will only work on WDC devices supporting this log page.
+Results for any other device are undefined.
+
+On success it returns the parsed error recovery log page data, error 
+code otherwise.
+
+OPTIONS
+-------
+-o <format>::
+--output-format=<format>::
+	Set the reporting format to 'normal', or
+	'json'. Only one output format can be used at a time.
+	Default is normal.
+
+EXAMPLES
+--------
+* Has the program issue WDC get-error-recovery-log plugin command :
++
+------------
+# nvme wdc get-error-recovery-log /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.
-- 
cgit v1.2.3