From: Tokunori Ikegami <ikegami.t@gmail.com>
Date: Sat, 21 Oct 2023 00:56:52 +0000 (+0900)
Subject: doc: Add id-ns-granularity command
X-Git-Tag: v2.7~118
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=ff94b7f9f7bbb1dbd0836183a331adeea811b0fa;p=users%2Fsagi%2Fnvme-cli.git

doc: Add id-ns-granularity command

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
---

diff --git a/Documentation/nvme-id-ns-granularity.txt b/Documentation/nvme-id-ns-granularity.txt
new file mode 100755
index 00000000..67006c33
--- /dev/null
+++ b/Documentation/nvme-id-ns-granularity.txt
@@ -0,0 +1,46 @@
+nvme-id-ns-granularity(1)
+=========================
+
+NAME
+----
+nvme-id-ns-granularity - Send a Identify Namespace Granularity List command to
+the specified device
+
+SYNOPSIS
+--------
+[verse]
+'nvme id-ns-granularity' <device>
+			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+Send a Identify Namespace Granularity List command command to the specified
+device, return results.
+
+The <device> parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).
+
+On success it returns 0, 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.
+
+-v::
+--verbose::
+	Increase the information detail in the output.
+
+EXAMPLES
+--------
+* Has the program issue a id-ns-granularity to display structure.
++
+------------
+# nvme id-ns-granularity /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite.