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-wdc-log-page-directory.txt | 43 +++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 Documentation/nvme-wdc-log-page-directory.txt

(limited to 'Documentation/nvme-wdc-log-page-directory.txt')

diff --git a/Documentation/nvme-wdc-log-page-directory.txt b/Documentation/nvme-wdc-log-page-directory.txt
new file mode 100644
index 0000000..27b5d9e
--- /dev/null
+++ b/Documentation/nvme-wdc-log-page-directory.txt
@@ -0,0 +1,43 @@
+nvme-wdc-log-page-directory(1)
+==============================
+
+NAME
+----
+nvme-wdc-log-page-directory - Retrieves the list of Log IDs supported by the drive
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc log-page-directory' <device> [--output-format=<normal|json|binary> -o <normal|json|binary>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, retrieves the log page directory which contains the list of 
+log page IDs supported by the drive. The --output-format option will format the output as
+specified.
+
+The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).
+
+This will only work on WDC devices supporting this feature.
+Results for any other device are undefined.
+
+On success it returns the log page directory information, error code otherwise.
+
+OPTIONS
+-------
+-o <fmt>::
+--output-format=<fmt>::
+	Set the reporting format to 'normal', 'json', or 'binary'. Only one output format
+	can be used at a time. The default is normal.
+
+EXAMPLES
+--------
+* WDC log-page-directory example command :
++
+------------
+# nvme wdc log-page-directory /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.
-- 
cgit v1.2.3