From f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Wed, 10 Apr 2024 21:41:32 +0200
Subject: Adding upstream version 2.8.

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

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

diff --git a/Documentation/nvme-error-log.txt b/Documentation/nvme-error-log.txt
new file mode 100644
index 0000000..94442ee
--- /dev/null
+++ b/Documentation/nvme-error-log.txt
@@ -0,0 +1,68 @@
+nvme-error-log(1)
+=================
+
+NAME
+----
+nvme-error-log - Send NVME Error log page request, return result and log
+
+SYNOPSIS
+--------
+[verse]
+'nvme error-log' <device> [--log-entries=<entries> | -e <entries>]
+			[--raw-binary | -b]
+			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+Retrieves NVMe Error log page from an NVMe device and provides the
+returned structure.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
+
+On success, the returned error log structure may be returned in one of
+several ways depending on the option flags; the structure may parsed by
+the program and printed in a readable format or the raw buffer may be
+printed to stdout for another program to parse.
+
+OPTIONS
+-------
+-e <entries>::
+--log-entries=<entries>::
+	Specifies how many log entries the program should request from
+	the device. This must be at least one, and shouldn't exceed the
+	device's capabilities. Defaults to 64 log entries.
+
+-b::
+--raw-binary::
+	Print the raw error log buffer to stdout.
+
+-o <fmt>::
+--output-format=<fmt>::
+	Set the reporting format to 'normal', 'json' or 'binary'. Only one
+	output format can be used at a time.
+
+-v::
+--verbose::
+	Increase the information detail in the output.
+
+EXAMPLES
+--------
+* Get the error log and print it in a human readable format:
++
+------------
+# nvme error-log /dev/nvme0
+------------
++
+
+* Print the raw output to a file:
++
+------------
+# nvme error-log /dev/nvme0 --raw-binary > error_log.raw
+------------
++
+It is probably a bad idea to not redirect stdout when using this mode.
+
+NVME
+----
+Part of the nvme-user suite
-- 
cgit v1.2.3