From 2b7a6d7a39cde8493a976abcdc601a899bbef96c Mon Sep 17 00:00:00 2001 From: Tokunori Ikegami Date: Mon, 24 Feb 2025 11:28:01 +0900 Subject: [PATCH] doc: add host-discovery-log command Added the nvme-host-discovery-log.txt file. Signed-off-by: Tokunori Ikegami --- Documentation/nvme-host-discovery-log.txt | 57 +++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 Documentation/nvme-host-discovery-log.txt diff --git a/Documentation/nvme-host-discovery-log.txt b/Documentation/nvme-host-discovery-log.txt new file mode 100644 index 0000000000..f99ee4fd87 --- /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' [--all-host-entries | -a] [--rae | -r] + [--verbose | -v] [--output-format= | -o ] + [--timeout=] + +DESCRIPTION +----------- +Retrieve Host Discovery Log, show it + +The parameter is mandatory NVMe MI device supported by the discovery +controller (ex: mctp:,[: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 :: +--output-format=:: + Set the reporting format to 'normal', 'json' or 'binary'. Only one + output format can be used at a time. + +-t :: +--timeout=:: + Override default timeout value. In milliseconds. + +EXAMPLES +-------- +* Has the program issue a host-discovery-log ++ +------------ +# nvme host-discovery-log mctp:,[:ctrl-id] +------------ + +NVME +---- +Part of the nvme-user suite.