Skip to content

Commit

Permalink
doc: add ave-discovery-log command
Browse files Browse the repository at this point in the history
Added the nvme-ave-discovery-log.txt file.

Signed-off-by: Tokunori Ikegami <ikegami.t@gmail.com>
  • Loading branch information
ikegami-t authored and igaw committed Feb 28, 2025
1 parent 2bffc59 commit c2ddcbf
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions Documentation/nvme-ave-discovery-log.txt
Original file line number Diff line number Diff line change
@@ -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' <device> [--rae | -r] [--verbose | -v]
[--output-format=<fmt> | -o <fmt>] [--timeout=<timeout>]

DESCRIPTION
-----------
Retrieve AVE Discovery Log, show it

The <device> 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 <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 ave-discovery-log
+
------------
# nvme ave-discovery-log /dev/nvme0
------------

NVME
----
Part of the nvme-user suite.

0 comments on commit c2ddcbf

Please sign in to comment.