From: Minwoo Im <minwoo.im.dev@gmail.com>
Date: Wed, 10 Jan 2018 15:52:17 +0000 (+0900)
Subject: nvme-cli: update error-log documentation
X-Git-Tag: v1.6~129^2
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=f6a2cc67593c392ca86444ee20005cc6c00d334d;p=users%2Fhch%2Fnvme-cli.git

nvme-cli: update error-log documentation

Update error-log documentation with removing nsid parameter.

Signed-off-by: Minwoo Im <minwoo.im.dev@gmail.com>
---

diff --git a/Documentation/nvme-error-log.1 b/Documentation/nvme-error-log.1
index 2149931..e39cc86 100644
--- a/Documentation/nvme-error-log.1
+++ b/Documentation/nvme-error-log.1
@@ -2,12 +2,12 @@
 .\"     Title: nvme-error-log
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
-.\"      Date: 12/10/2017
+.\"      Date: 01/11/2018
 .\"    Manual: NVMe Manual
 .\"    Source: NVMe
 .\"  Language: English
 .\"
-.TH "NVME\-ERROR\-LOG" "1" "12/10/2017" "NVMe" "NVMe Manual"
+.TH "NVME\-ERROR\-LOG" "1" "01/11/2018" "NVMe" "NVMe Manual"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -32,8 +32,7 @@ nvme-error-log \- Send NVME Error log page request, return result and log
 .SH "SYNOPSIS"
 .sp
 .nf
-\fInvme error\-log\fR <device>  [\-\-namespace\-id=<nsid> | \-n <nsid>]
-                         [\-\-log\-entries=<entries> | \-e <entries>]
+\fInvme error\-log\fR <device>  [\-\-log\-entries=<entries> | \-e <entries>]
                          [\-\-raw\-binary | \-b]
                          [\-\-output\-format=<fmt> | \-o <fmt>]
 .fi
@@ -46,11 +45,6 @@ The <device> parameter is mandatory and may be either the NVMe character device
 On success, the returned error log structure may be returned in one of several ways depending on the option flags; the structure may parsed by the program and printed in a readable format or the raw buffer may be printed to stdout for another program to parse\&.
 .SH "OPTIONS"
 .PP
-\-n <nsid>, \-\-namespace\-id=<nsid>
-.RS 4
-Retrieve the Error Log for the given nsid\&. This is optional and its success may depend on the device\(cqs capabilities to provide this log on a per\-namespace basis (see the NVMe Identify Controller for this capability)\&. The default nsid to use is 0xffffffff for the device global error log\&.
-.RE
-.PP
 \-e <entries>, \-\-log\-entries=<entries>
 .RS 4
 Specifies how many log entries the program should request from the device\&. This must be at least one, and shouldn\(cqt exceed the device\(cqs capabilities\&. Defaults to 64 log entries\&.
diff --git a/Documentation/nvme-error-log.html b/Documentation/nvme-error-log.html
index 1c4e1d1..479fd36 100644
--- a/Documentation/nvme-error-log.html
+++ b/Documentation/nvme-error-log.html
@@ -746,8 +746,7 @@ nvme-error-log(1) Manual Page
 <h2 id="_synopsis">SYNOPSIS</h2>
 <div class="sectionbody">
 <div class="verseblock">
-<pre class="content"><em>nvme error-log</em> &lt;device&gt;  [--namespace-id=&lt;nsid&gt; | -n &lt;nsid&gt;]
-                         [--log-entries=&lt;entries&gt; | -e &lt;entries&gt;]
+<pre class="content"><em>nvme error-log</em> &lt;device&gt;  [--log-entries=&lt;entries&gt; | -e &lt;entries&gt;]
                          [--raw-binary | -b]
                          [--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>
 <div class="attribution">
@@ -772,21 +771,6 @@ printed to stdout for another program to parse.</p></div>
 <div class="sectionbody">
 <div class="dlist"><dl>
 <dt class="hdlist1">
--n &lt;nsid&gt;
-</dt>
-<dt class="hdlist1">
---namespace-id=&lt;nsid&gt;
-</dt>
-<dd>
-<p>
-        Retrieve the Error Log for the given nsid. This is optional
-        and its success may depend on the device&#8217;s capabilities to
-        provide this log on a per-namespace basis (see the NVMe Identify
-        Controller for this capability). The default nsid to use is
-        0xffffffff for the device global error log.
-</p>
-</dd>
-<dt class="hdlist1">
 -e &lt;entries&gt;
 </dt>
 <dt class="hdlist1">
diff --git a/Documentation/nvme-error-log.txt b/Documentation/nvme-error-log.txt
index f173a03..9a423cc 100644
--- a/Documentation/nvme-error-log.txt
+++ b/Documentation/nvme-error-log.txt
@@ -8,8 +8,7 @@ nvme-error-log - Send NVME Error log page request, return result and log
 SYNOPSIS
 --------
 [verse]
-'nvme error-log' <device>  [--namespace-id=<nsid> | -n <nsid>]
-			 [--log-entries=<entries> | -e <entries>]
+'nvme error-log' <device>  [--log-entries=<entries> | -e <entries>]
 			 [--raw-binary | -b]
 			 [--output-format=<fmt> | -o <fmt>]
 
@@ -28,14 +27,6 @@ printed to stdout for another program to parse.
 
 OPTIONS
 -------
--n <nsid>::
---namespace-id=<nsid>::
-	Retrieve the Error Log for the given nsid. This is optional
-	and its success may depend on the device's capabilities to
-	provide this log on a per-namespace basis (see the NVMe Identify
-	Controller for this capability). The default nsid to use is
-	0xffffffff for the device global error log.
-
 -e <entries>::
 --log-entries=<entries>::
 	Specifies how many log entries the program should request from