From: Tokunori Ikegami <ikegami.t@gmail.com>
Date: Mon, 24 Feb 2025 02:28:01 +0000 (+0900)
Subject: doc: add host-discovery-log command
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=2b7a6d7a39cde8493a976abcdc601a899bbef96c;p=users%2Fsagi%2Fnvme-cli.git

doc: add host-discovery-log command

Added the nvme-host-discovery-log.txt file.

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

diff --git a/Documentation/nvme-host-discovery-log.txt b/Documentation/nvme-host-discovery-log.txt
new file mode 100644
index 00000000..f99ee4fd
--- /dev/null
+++ b/Documentation/nvme-host-discovery-log.txt
@@ -0,0 +1,57 @@
+nvme-host-discovery-log(1)
+==========================
+
+NAME
+----
+nvme-host-discovery-log - Retrieve Host Discovery Log, show it
+
+SYNOPSIS
+--------
+[verse]
+'nvme host-discovery-log' <device> [--all-host-entries | -a] [--rae | -r]
+			[--verbose | -v] [--output-format=<fmt> | -o <fmt>]
+			[--timeout=<timeout>]
+
+DESCRIPTION
+-----------
+Retrieve Host Discovery Log, show it
+
+The <device> parameter is mandatory NVMe MI device supported by the discovery
+controller (ex: mctp:<net>,<eid>[:ctrl-id]).
+
+On success it returns 0, error code otherwise.
+
+OPTIONS
+-------
+-a::
+--all-host-entries::
+	All Host Entries.
+
+-r::
+--rae::
+	Retain an Asynchronous Event.
+
+-v::
+--verbose::
+	Increase the information detail in the output.
+
+-o <fmt>::
+--output-format=<fmt>::
+	Set the reporting format to 'normal', 'json' or 'binary'. Only one
+	output format can be used at a time.
+
+-t <timeout>::
+--timeout=<timeout>::
+	Override default timeout value. In milliseconds.
+
+EXAMPLES
+--------
+* Has the program issue a host-discovery-log
++
+------------
+# nvme host-discovery-log mctp:<net>,<eid>[:ctrl-id]
+------------
+
+NVME
+----
+Part of the nvme-user suite.