From: Jeff Lien <jeff.lien@wdc.com>
Date: Wed, 30 Mar 2022 18:02:10 +0000 (-0500)
Subject: documentation: Add doc files for new wdc plugin commands
X-Git-Tag: v2.0~14^2~1
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=9be2337709a10189aefc3b13633caea422340f82;p=users%2Fsagi%2Fnvme-cli.git

documentation: Add doc files for new wdc plugin commands

Signed-off-by: Jeff Lien <jeff.lien@wdc.com>
---

diff --git a/Documentation/meson.build b/Documentation/meson.build
index 749d0022..c0160073 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -118,9 +118,12 @@ adoc_sources = [
   'nvme-wdc-drive-resize',
   'nvme-wdc-enc-get-log',
   'nvme-wdc-get-crash-dump',
+  'nvme-wdc-get-dev-capabilities-log',
   'nvme-wdc-get-drive-status',
+  'nvme-wdc-get-error-recovery-log',
   'nvme-wdc-get-latency-monitor-log',
   'nvme-wdc-get-pfail-dump',
+  'nvme-wdc-get-unsupported-reqs-log',
   'nvme-wdc-id-ctrl',
   'nvme-wdc-log-page-directory',
   'nvme-wdc-namespace-resize',
diff --git a/Documentation/nvme-wdc-get-dev-capabilities-log.txt b/Documentation/nvme-wdc-get-dev-capabilities-log.txt
new file mode 100644
index 00000000..06218812
--- /dev/null
+++ b/Documentation/nvme-wdc-get-dev-capabilities-log.txt
@@ -0,0 +1,48 @@
+nvme-wdc-get-dev-capabilities-log(1)
+====================================
+
+NAME
+----
+nvme-wdc-get-dev-capabilities-log - Send NVMe WDC get-dev-capabilities-log 
+									plugin command, return parsed log output
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc get-dev-capabilities-log' <device> [--output-format=<normal|json> 
+-o <normal|json>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, send a WDC plugin get-dev-capabilities-log command
+and output the device capabilities 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 device capabilities 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-dev-capabilities-log plugin command :
++
+------------
+# nvme wdc get-dev-capabilities-log /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.
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 00000000..2ad3605f
--- /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.
diff --git a/Documentation/nvme-wdc-get-unsupported-reqs-log.txt b/Documentation/nvme-wdc-get-unsupported-reqs-log.txt
new file mode 100644
index 00000000..f028665d
--- /dev/null
+++ b/Documentation/nvme-wdc-get-unsupported-reqs-log.txt
@@ -0,0 +1,48 @@
+nvme-wdc-get-unsupported-reqs-log(1)
+====================================
+
+NAME
+----
+nvme-wdc-get-unsupported-reqs-log - Send NVMe WDC get-unsupported-reqs-log 
+									plugin command, return parsed log output
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc get-unsupported-reqs-log' <device> [--output-format=<normal|json> 
+-o <normal|json>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, send a WDC plugin get-unsupported-reqs-log command 
+and output the unsupported requirements 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 unsupported requirements 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-unsupported-reqs-log plugin command :
++
+------------
+# nvme wdc get-unsupported-reqs-log /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.