summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-latency-monitor-log.1
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-ocp-latency-monitor-log.1 (renamed from Documentation/nvme-lnvm-init.1)58
1 files changed, 20 insertions, 38 deletions
diff --git a/Documentation/nvme-lnvm-init.1 b/Documentation/nvme-ocp-latency-monitor-log.1
index a6eff88..9c38abd 100644
--- a/Documentation/nvme-lnvm-init.1
+++ b/Documentation/nvme-ocp-latency-monitor-log.1
@@ -1,13 +1,13 @@
'\" t
-.\" Title: nvme-lnvm-init
+.\" Title: nvme-ocp-latency-monitor-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 11/11/2021
+.\" Date: 04/08/2022
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LNVM\-INIT" "1" "11/11/2021" "NVMe" "NVMe Manual"
+.TH "NVME\-OCP\-LATENCY\-" "1" "04/08/2022" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,26 +28,29 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-nvme-lnvm-init \- Initialize LightNVM device with media manager
+nvme-ocp-latency-monitor-log \- Display latency monitor log page data in human readable format
.SH "SYNOPSIS"
.sp
.nf
-\fInvme lnvm\-init\fR [\-\-device\-name=<DEVICE> | \-d <DEVICE>]
- [\-\-mediamgr\-name | \-m]
+\fInvme ocp latency\-monitor\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
-Initialize LightNVM device\&. A LightNVM/Open\-Channel SSD must have a media manager associated before it can be exposed to the user\&. The default is to initialize the general media manager on top of the device\&.
+For the NVMe device given, latency monitor log page data\&.
+.sp
+The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1)\&.
+.sp
+This will only work on OCP compliant devices supporting this log page\&. Results for any other device are undefined\&.
+.sp
+On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-\-device\-name=<DEVICE>, \-d <DEVICE>
+\-o <format>, \-\-output\-format=<format>
.RS 4
-Device name to initialize\&.
-.RE
-.PP
-\-\-mediamgr\-name=<MediaMgr>, \-m <MediaMgr>
-.RS 4
-Media Manager name to use for initialization\&.
+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
@@ -59,39 +62,18 @@ Media Manager name to use for initialization\&.
.sp -1
.IP \(bu 2.3
.\}
-Initialize nvme0n1
-.RE
+Displays the get latency monitor log for the device:
.sp
.if n \{\
.RS 4
.\}
.nf
-# nvme lnvm\-init \-d nvme0n1
+# nvme ocp latency\-monitor\-log /dev/nvme0
.fi
.if n \{\
.RE
.\}
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Initialize nvme0n1 with gennvm media manager (default media manager)
-.RE
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-# nvme lnvm\-init \-d nvme0n1 \-m gennvm
-.fi
-.if n \{\
.RE
-.\}
.SH "NVME"
.sp
-Part of the nvme\-user suite
+Part of the nvme\-user suite\&.