From: Jeff Lien <jeff.lien@wdc.com>
Date: Tue, 3 May 2022 22:00:46 +0000 (-0500)
Subject: doc: Add doc files for wdc vs-device-waf command
X-Git-Tag: v2.1-rc0~52^2~3
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=e4edf9b58c543f6f1f1e41334c43b2bc98ed7d41;p=users%2Fsagi%2Fnvme-cli.git

doc: Add doc files for wdc vs-device-waf command

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

diff --git a/Documentation/meson.build b/Documentation/meson.build
index ef8a46a1..c5ce0f00 100644
--- a/Documentation/meson.build
+++ b/Documentation/meson.build
@@ -133,6 +133,7 @@ adoc_sources = [
   'nvme-wdc-purge',
   'nvme-wdc-purge-monitor',
   'nvme-wdc-vs-cloud-log',
+  'nvme-wdc-vs-device-waf',
   'nvme-wdc-vs-drive-info',
   'nvme-wdc-vs-error-reason-identifier',
   'nvme-wdc-vs-fw-activate-history',
diff --git a/Documentation/nvme-wdc-vs-device-waf.txt b/Documentation/nvme-wdc-vs-device-waf.txt
new file mode 100644
index 00000000..55095a4d
--- /dev/null
+++ b/Documentation/nvme-wdc-vs-device-waf.txt
@@ -0,0 +1,53 @@
+nvme-wdc-vs-device-waf(1)
+=========================
+
+NAME
+----
+nvme-wdc-vs-device-waf - Calculates the device write amplification factor and
+prints both TLC and SLC results
+
+SYNOPSIS
+--------
+[verse]
+'nvme wdc vs-device-waf' <device> [--output-format=<normal|json> -o <normal|json>]
+			[--namespace-id=<nsid> | -n <nsid>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, calculates the device TLC and SLC write 
+amplification factor.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).
+
+This will only work on WDC devices supporting this feature.
+Results for any other device are undefined.
+
+On success it returns 0, 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.
+
+-n <nsid>::
+--namespace-id=<nsid>::
+	Sets the command's nsid value to the given nsid. Defaults to
+	0xffffffff if not given. This option may not affect anything
+	depending on the log page, which may or may not be specific to
+	a namespace.
+
+EXAMPLES
+--------
+* Has the program issue WDC vs-device-waf plugin Command :
++
+------------
+# nvme wdc vs-device-waf /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.