From: Jeff Lien <jeff.lien@wdc.com>
Date: Tue, 22 Mar 2022 19:56:01 +0000 (-0500)
Subject: docs: Add Documentation files for get_mi_cmd_support_effects_log
X-Git-Tag: v2.0-rc8~5^2~2
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=411053069827d3c529a04ffd4e65dcd1bb55de5e;p=users%2Fsagi%2Fnvme-cli.git

docs: Add Documentation files for get_mi_cmd_support_effects_log

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

diff --git a/Documentation/meson.build b/Documentation/meson.build
index e2101494..dbdabc66 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -27,6 +27,7 @@ adoc_sources = [
   'nvme-endurance-log',
   'nvme-error-log',
   'nvme-fid-support-effects-log',
+  'nvme-mi-cmd-support-effects-log',
   'nvme-flush',
   'nvme-format',
   'nvme-fw-commit',
diff --git a/Documentation/nvme-mi-cmd-support-effects-log.txt b/Documentation/nvme-mi-cmd-support-effects-log.txt
new file mode 100644
index 00000000..67b8355f
--- /dev/null
+++ b/Documentation/nvme-mi-cmd-support-effects-log.txt
@@ -0,0 +1,45 @@
+nvme-mi-cmd-support-effects-log(1)
+==================================
+
+NAME
+----
+nvme-mi-cmd-support-effects-log - Send NVMe MI Command Support and Effects log,
+                                  returns results and structure
+
+SYNOPSIS
+--------
+[verse]
+'nvme-mi-cmd-support-effects-log' <device> [-o <fmt> | --output-format=<fmt>]
+					[-H | --human-readable]
+
+DESCRIPTION
+-----------
+For the NVMe device given, sends an MI Command Support and Effects log (id 13h)
+and provides the result and returned log 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 structure may be returned in one of several ways depending
+on the option flags; the structure may be parsed by the program or the
+raw buffer may be printed to stdout.
+
+OPTIONS
+-------
+-o <format>::
+--output-format=<format>::
+    Set the reporting format to 'normal', 'json', or
+    'binary'. Only one output format can be used at a time.
+
+-H::
+--human-readable::
+	This option will parse and format many of the bit fields
+	into human-readable formats.
+
+EXAMPLES
+--------
+nvme mi-cmd-support-effects-log /dev/nvme0 -H
+
+NVME
+----
+Part of the nvme-user suite