From: Jeff Lien Date: Fri, 22 Oct 2021 21:50:52 +0000 (-0500) Subject: Add documentation files for get-latency-monitor-log X-Git-Tag: v2.0-rc0~53^2~1 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=ea099afb7e8cd56cd0957d8173591db019d54b6c;p=users%2Fsagi%2Fnvme-cli.git Add documentation files for get-latency-monitor-log --- diff --git a/Documentation/nvme-wdc-get-latency-monitor-log.1 b/Documentation/nvme-wdc-get-latency-monitor-log.1 new file mode 100644 index 00000000..9c98072a --- /dev/null +++ b/Documentation/nvme-wdc-get-latency-monitor-log.1 @@ -0,0 +1,79 @@ +'\" t +.\" Title: nvme-wdc-get-latency-monitor-log +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 10/22/2021 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-WDC\-GET\-LATE" "1" "10/22/2021" "NVMe" "NVMe Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nvme-wdc-get-latency-monitor-log \- Display latency monitor log page data in human readable format +.SH "SYNOPSIS" +.sp +.nf +\fInvme wdc get\-latency\-monitor\-log\fR [\-\-output\-format= \-o ] +.fi +.SH "DESCRIPTION" +.sp +For the NVMe device given, latency monitor log page data\&. +.sp +The parameter is mandatory NVMe character device (ex: /dev/nvme0)\&. +.sp +This will only work on WDC devices supporting this log page\&. Results for any other device are undefined\&. +.sp +On success it returns 0, error code otherwise\&. +.SH "OPTIONS" +.PP +\-o , \-\-output\-format= +.RS 4 +Set the reporting format to +\fInormal\fR +or +\fIjson\fR\&. Only one output format can be used at a time\&. The default is normal\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Displays the get latency monitor log for the device: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme wdc get\-latency\-monitor\-log /dev/nvme0 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "NVME" +.sp +Part of the nvme\-user suite\&. diff --git a/Documentation/nvme-wdc-get-latency-monitor-log.html b/Documentation/nvme-wdc-get-latency-monitor-log.html new file mode 100644 index 00000000..0c869891 --- /dev/null +++ b/Documentation/nvme-wdc-get-latency-monitor-log.html @@ -0,0 +1,817 @@ + + + + + + +nvme-wdc-get-latency-monitor-log(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme wdc get-latency-monitor-log <device> [--output-format=<normal|json> -o <normal|json>]
+
+
+
+
+
+

DESCRIPTION

+
+

For the NVMe device given, latency monitor log page data.

+

The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).

+

This will only work on WDC devices supporting this log page. +Results for any other device are undefined.

+

On success it returns 0, error code otherwise.

+
+
+
+

OPTIONS

+
+
+
+-o <format> +
+
+--output-format=<format> +
+
+

+ Set the reporting format to normal or json. Only one output format + can be used at a time. The default is normal. +

+
+
+
+
+
+

EXAMPLES

+
+
    +
  • +

    +Displays the get latency monitor log for the device: +

    +
    +
    +
    # nvme wdc get-latency-monitor-log /dev/nvme0
    +
    +
    • +
+
+
+
+

NVME

+
+

Part of the nvme-user suite.

+
+
+
+
+ + + diff --git a/Documentation/nvme-wdc-get-latency-monitor-log.txt b/Documentation/nvme-wdc-get-latency-monitor-log.txt new file mode 100644 index 00000000..19fda4a9 --- /dev/null +++ b/Documentation/nvme-wdc-get-latency-monitor-log.txt @@ -0,0 +1,42 @@ +nvme-wdc-get-latency-monitor-log(1) +=================================== + +NAME +---- +nvme-wdc-get-latency-monitor-log - Display latency monitor log page data in human readable format + +SYNOPSIS +-------- +[verse] +'nvme wdc get-latency-monitor-log' [--output-format= -o ] + +DESCRIPTION +----------- + +For the NVMe device given, latency monitor log page data. + +The parameter is mandatory NVMe character device (ex: /dev/nvme0). + +This will only work on WDC devices supporting this log page. +Results for any other device are undefined. + +On success it returns 0, error code otherwise. + +OPTIONS +------- +-o :: +--output-format=:: + Set the reporting format to 'normal' or 'json'. Only one output format + can be used at a time. The default is normal. + +EXAMPLES +-------- +* Displays the get latency monitor log for the device: ++ +------------ +# nvme wdc get-latency-monitor-log /dev/nvme0 +------------ + +NVME +---- +Part of the nvme-user suite.