From c2ddcbfadf79ad3781bf5537b9c1da06913abd41 Mon Sep 17 00:00:00 2001 From: Tokunori Ikegami Date: Fri, 28 Feb 2025 01:34:09 +0900 Subject: [PATCH] doc: add ave-discovery-log command Added the nvme-ave-discovery-log.txt file. Signed-off-by: Tokunori Ikegami --- Documentation/nvme-ave-discovery-log.txt | 51 ++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 Documentation/nvme-ave-discovery-log.txt diff --git a/Documentation/nvme-ave-discovery-log.txt b/Documentation/nvme-ave-discovery-log.txt new file mode 100644 index 00000000..75de3614 --- /dev/null +++ b/Documentation/nvme-ave-discovery-log.txt @@ -0,0 +1,51 @@ +nvme-ave-discovery-log(1) +========================= + +NAME +---- +nvme-ave-discovery-log - Retrieve AVE Discovery Log, show it + +SYNOPSIS +-------- +[verse] +'nvme ave-discovery-log' [--rae | -r] [--verbose | -v] + [--output-format= | -o ] [--timeout=] + +DESCRIPTION +----------- +Retrieve AVE Discovery Log, show it + +The parameter is mandatory NVMe character device (ex: /dev/nvme0). + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-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 ave-discovery-log ++ +------------ +# nvme ave-discovery-log /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite. -- 2.50.1