summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-latency-monitor-log.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-ocp-latency-monitor-log.html (renamed from Documentation/nvme-lnvm-init.html)61
1 files changed, 21 insertions, 40 deletions
diff --git a/Documentation/nvme-lnvm-init.html b/Documentation/nvme-ocp-latency-monitor-log.html
index d1bee83..b3c21d7 100644
--- a/Documentation/nvme-lnvm-init.html
+++ b/Documentation/nvme-ocp-latency-monitor-log.html
@@ -4,8 +4,8 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.6.10" />
-<title>nvme-lnvm-init(1)</title>
+<meta name="generator" content="AsciiDoc" />
+<title>nvme-ocp-latency-monitor-log(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -436,7 +436,7 @@ thead, p.table.header {
p.table {
margin-top: 0;
}
-/* Because the table frame attribute is overriden by CSS in most browsers. */
+/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
@@ -735,12 +735,12 @@ asciidoc.install();
<body class="manpage">
<div id="header">
<h1>
-nvme-lnvm-init(1) Manual Page
+nvme-ocp-latency-monitor-log(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
-<p>nvme-lnvm-init -
- Initialize LightNVM device with media manager
+<p>nvme-ocp-latency-monitor-log -
+ Display latency monitor log page data in human readable format
</p>
</div>
</div>
@@ -749,8 +749,7 @@ nvme-lnvm-init(1) Manual Page
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
-<pre class="content"><em>nvme lnvm-init</em> [--device-name=&lt;DEVICE&gt; | -d &lt;DEVICE&gt;]
- [--mediamgr-name | -m]</pre>
+<pre class="content"><em>nvme ocp latency-monitor-log</em> &lt;device&gt; [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>
<div class="attribution">
</div></div>
</div>
@@ -758,9 +757,12 @@ nvme-lnvm-init(1) Manual Page
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>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.</p></div>
+<div class="paragraph"><p>For the NVMe device given, latency monitor log page data.</p></div>
+<div class="paragraph"><p>The &lt;device&gt; parameter is mandatory and may be either the NVMe character
+device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).</p></div>
+<div class="paragraph"><p>This will only work on OCP compliant devices supporting this log page.
+Results for any other device are undefined.</p></div>
+<div class="paragraph"><p>On success it returns 0, error code otherwise.</p></div>
</div>
</div>
<div class="sect1">
@@ -768,25 +770,15 @@ initialize the general media manager on top of the device.</p></div>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
---device-name=&lt;DEVICE&gt;
+-o &lt;format&gt;
</dt>
<dt class="hdlist1">
--d &lt;DEVICE&gt;
+--output-format=&lt;format&gt;
</dt>
<dd>
<p>
- Device name to initialize.
-</p>
-</dd>
-<dt class="hdlist1">
---mediamgr-name=&lt;MediaMgr&gt;
-</dt>
-<dt class="hdlist1">
--m &lt;MediaMgr&gt;
-</dt>
-<dd>
-<p>
- Media Manager name to use for initialization.
+ Set the reporting format to <em>normal</em> or <em>json</em>. Only one output format
+ can be used at a time. The default is normal.
</p>
</dd>
</dl></div>
@@ -798,31 +790,20 @@ initialize the general media manager on top of the device.</p></div>
<div class="ulist"><ul>
<li>
<p>
-Initialize nvme0n1
+Displays the get latency monitor log for the device:
</p>
-</li>
-</ul></div>
<div class="listingblock">
<div class="content">
-<pre><code># nvme lnvm-init -d nvme0n1</code></pre>
+<pre><code># nvme ocp latency-monitor-log /dev/nvme0</code></pre>
</div></div>
-<div class="ulist"><ul>
-<li>
-<p>
-Initialize nvme0n1 with gennvm media manager (default media manager)
-</p>
</li>
</ul></div>
-<div class="listingblock">
-<div class="content">
-<pre><code># nvme lnvm-init -d nvme0n1 -m gennvm</code></pre>
-</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_nvme">NVME</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Part of the nvme-user suite</p></div>
+<div class="paragraph"><p>Part of the nvme-user suite.</p></div>
</div>
</div>
</div>
@@ -830,7 +811,7 @@ Initialize nvme0n1 with gennvm media manager (default media manager)
<div id="footer">
<div id="footer-text">
Last updated
- 2021-07-19 10:10:19 PDT
+ 2022-04-08 18:46:59 CEST
</div>
</div>
</body>