Skip to content

Commit e03c434

Browse files
kelvin-caokelvin-cao
committed
Merge branch 'devel'
2 parents d1df091 + 51bf2c0 commit e03c434

File tree

393 files changed

+55756
-11048
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

393 files changed

+55756
-11048
lines changed

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,7 @@ tags
1313
/debian/nvme-cli.debhelper.log
1414
/debian/nvme-cli.substvars
1515
/debian/nvme-cli
16+
17+
tests/__pycache__
18+
tests/nvmetests
19+
tests/*.pyc

‎Documentation/Makefile‎

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,23 @@ API_DOCS =
1818
SP_ARTICLES += $(API_DOCS)
1919
SP_ARTICLES += $(TECH_DOCS)
2020

21+
ifneq ($(findstring $(MAKEFLAGS),s),s)
22+
ifndef V
23+
QUIET_ASCIIDOC = @echo ' ' ASCIIDOC $@;
24+
QUIET_XMLTO = @echo ' ' XMLTO $@;
25+
QUIET_DB2TEXI = @echo ' ' DB2TEXI $@;
26+
QUIET_MAKEINFO = @echo ' ' MAKEINFO $@;
27+
QUIET_DBLATEX = @echo ' ' DBLATEX $@;
28+
QUIET_XSLTPROC = @echo ' ' XSLTPROC $@;
29+
QUIET_GEN = @echo ' ' GEN $@;
30+
QUIET_LINT = @echo ' ' LINT $@;
31+
QUIET_STDERR = 2> /dev/null
32+
QUIET_SUBDIR0 = +@subdir=
33+
QUIET_SUBDIR1 = ;$(NO_SUBDIR) echo ' ' SUBDIR $$subdir; \
34+
$(MAKE) $(PRINT_DIR) -C $$subdir
35+
export V
36+
endif
37+
endif
2138

2239
DOC_MAN1 = $(patsubst %.txt,%.1,$(MAN1_TXT))
2340

@@ -28,13 +45,26 @@ ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA)
2845
TXT_TO_XML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_DOCBOOK)
2946
MANPAGE_XSL = manpage-normal.xsl
3047
XMLTO = xmlto
31-
XMLTO_EXTRA =
48+
XMLTO_EXTRA = --skip-validation
3249
INSTALL ?= install
3350
RM ?= rm -f
3451
MAN_REPO = ../../nvme-manpages
3552

3653
ASCIIDOC_HTML = xhtml11
3754
ASCIIDOC_CONF = -f asciidoc.conf
55+
56+
ifdef USE_ASCIIDOCTOR
57+
ASCIIDOC = asciidoctor
58+
ASCIIDOC_CONF =
59+
ASCIIDOC_HTML = xhtml5
60+
ASCIIDOC_DOCBOOK = docbook5
61+
ASCIIDOC_EXTRA += -acompat-mode
62+
ASCIIDOC_EXTRA += -I. -rasciidoctor-extensions
63+
ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
64+
ASCIIDOC_EXTRA += -amansource='NVMe'
65+
ASCIIDOC_EXTRA += -amanmanual='NVMe Manual'
66+
endif
67+
3868
ASCIIDOC_COMMON = $(ASCIIDOC) $(ASCIIDOC_EXTRA) $(ASCIIDOC_CONF)
3969
TXT_TO_HTML = $(ASCIIDOC_COMMON) -b $(ASCIIDOC_HTML)
4070

‎Documentation/asciidoctor-extensions.rb‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
require 'asciidoctor'
2+
require 'asciidoctor/extensions'
3+
4+
module Nvme
5+
module Documentation
6+
class LinkNvmeProcessor < Asciidoctor::Extensions::InlineMacroProcessor
7+
use_dsl
8+
9+
named :chrome
10+
11+
def process(parent, target, attrs)
12+
if parent.document.basebackend? 'html'
13+
%(<a href="#{target}.html">#{target}(#{attrs[1]})</a>\n)
14+
elsif parent.document.basebackend? 'manpage'
15+
"#{target}(#{attrs[1]})"
16+
elsif parent.document.basebackend? 'docbook'
17+
"<citerefentry>\n" \
18+
"<refentrytitle>#{target}</refentrytitle>" \
19+
"<manvolnum>#{attrs[1]}</manvolnum>\n" \
20+
"</citerefentry>\n"
21+
end
22+
end
23+
end
24+
end
25+
end
26+
27+
Asciidoctor::Extensions.register do
28+
inline_macro Nvme::Documentation::LinkNvmeProcessor, :linknvme
29+
end

‎Documentation/cmds-main.txt‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,17 @@ linknvme:nvme-show-regs[1]::
121121
linknvme:nvme-discover[1]::
122122
Send Get Log Page request to Discovery Controller
123123

124+
linknvme:nvme-connect-all[1]::
125+
Discover and connect to all NVMe-over-Fabrics subsystems
126+
124127
linknvme:nvme-connect[1]::
125128
Connect to an NVMe-over-Fabrics subsystem
126129

130+
linknvme:nvme-disconnect[1]::
131+
Disconnect from an NVMe-over-Fabrics subsystem
132+
133+
linknvme:nvme-disconnect-all[1]::
134+
Disconnect from all NVMe-over-Fabrics subsystems
135+
136+
linknvme:nvme-get-property[1]::
137+
Reads and shows NVMe-over-Fabrics controller property

‎Documentation/nvme-admin-passthru.1‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
.\" Title: nvme-admin-passthru
33
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
44
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5-
.\" Date: 03/01/2018
5+
.\" Date: 04/24/2020
66
.\" Manual: NVMe Manual
77
.\" Source: NVMe
88
.\" Language: English
99
.\"
10-
.TH "NVME\-ADMIN\-PASSTHR" "1" "03/01/2018" "NVMe" "NVMe Manual"
10+
.TH "NVME\-ADMIN\-PASSTHR" "1" "04/24/2020" "NVMe" "NVMe Manual"
1111
.\" -----------------------------------------------------------------
1212
.\" * Define some portability stuff
1313
.\" -----------------------------------------------------------------
@@ -39,7 +39,7 @@ nvme-admin-passthru \- Submit an arbitrary admin command, return results
3939
[\-\-cdw13=<cdw13>] [\-\-cdw14=<cdw14>] [\-\-cdw15=<cdw15>]
4040
[\-\-data\-len=<data\-len> | \-l <data\-len>]
4141
[\-\-metadata\-len=<len> | \-m <len>]
42-
[\-\-input\-file=<file> | \-f <file>]
42+
[\-\-input\-file=<file> | \-i <file>]
4343
[\-\-read | \-r ] [\-\-write | \-w]
4444
[\-\-timeout=<to> | \-t <to>]
4545
[\-\-show\-command | \-s]
@@ -110,7 +110,7 @@ Print out the command to be sent\&.
110110
.RS 4
111111
Do not actually send the command\&. If want to use \-\-dry\-run option, \-\-show\-cmd option
112112
\fImust\fR
113-
be set\&. Otherwise \-\-dry\-run optionn will be
113+
be set\&. Otherwise \-\-dry\-run option will be
114114
\fIignored\fR\&.
115115
.RE
116116
.PP

‎Documentation/nvme-admin-passthru.html‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
44
<head>
55
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
6-
<meta name="generator" content="AsciiDoc 8.6.9" />
6+
<meta name="generator" content="AsciiDoc 8.6.8" />
77
<title>nvme-admin-passthru(1)</title>
88
<style type="text/css">
99
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
@@ -94,9 +94,7 @@
9494
padding: 0;
9595
margin: 0;
9696
}
97-
pre {
98-
white-space: pre-wrap;
99-
}
97+
10098

10199
#author {
102100
color: #527bbd;
@@ -225,7 +223,7 @@
225223
}
226224

227225
div.imageblock div.content { padding-left: 0; }
228-
span.image img { border-style: none; vertical-align: text-bottom; }
226+
span.image img { border-style: none; }
229227
a.image:visited { color: white; }
230228

231229
dl {
@@ -755,7 +753,7 @@ <h2 id="_synopsis">SYNOPSIS</h2>
755753
[--cdw13=&lt;cdw13&gt;] [--cdw14=&lt;cdw14&gt;] [--cdw15=&lt;cdw15&gt;]
756754
[--data-len=&lt;data-len&gt; | -l &lt;data-len&gt;]
757755
[--metadata-len=&lt;len&gt; | -m &lt;len&gt;]
758-
[--input-file=&lt;file&gt; | -f &lt;file&gt;]
756+
[--input-file=&lt;file&gt; | -i &lt;file&gt;]
759757
[--read | -r ] [--write | -w]
760758
[--timeout=&lt;to&gt; | -t &lt;to&gt;]
761759
[--show-command | -s]
@@ -912,7 +910,7 @@ <h2 id="_options">OPTIONS</h2>
912910
<dd>
913911
<p>
914912
Do not actually send the command. If want to use --dry-run option,
915-
--show-cmd option <em>must</em> be set. Otherwise --dry-run optionn will be
913+
--show-cmd option <em>must</em> be set. Otherwise --dry-run option will be
916914
<em>ignored</em>.
917915
</p>
918916
</dd>
@@ -984,8 +982,7 @@ <h2 id="_nvme">NVME</h2>
984982
<div id="footnotes"><hr /></div>
985983
<div id="footer">
986984
<div id="footer-text">
987-
Last updated
988-
2018-01-30 19:28:39 KST
985+
Last updated 2019-09-06 10:35:44 MDT
989986
</div>
990987
</div>
991988
</body>

‎Documentation/nvme-admin-passthru.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ SYNOPSIS
1515
[--cdw13=<cdw13>] [--cdw14=<cdw14>] [--cdw15=<cdw15>]
1616
[--data-len=<data-len> | -l <data-len>]
1717
[--metadata-len=<len> | -m <len>]
18-
[--input-file=<file> | -f <file>]
18+
[--input-file=<file> | -i <file>]
1919
[--read | -r ] [--write | -w]
2020
[--timeout=<to> | -t <to>]
2121
[--show-command | -s]
@@ -89,7 +89,7 @@ OPTIONS
8989
-d::
9090
--dry-run::
9191
Do not actually send the command. If want to use --dry-run option,
92-
--show-cmd option _must_ be set. Otherwise --dry-run optionn will be
92+
--show-cmd option _must_ be set. Otherwise --dry-run option will be
9393
_ignored_.
9494

9595
-b::

‎Documentation/nvme-ana-log.1‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
'\" t
2+
.\" Title: nvme-ana-log
3+
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4+
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5+
.\" Date: 04/24/2020
6+
.\" Manual: NVMe Manual
7+
.\" Source: NVMe
8+
.\" Language: English
9+
.\"
10+
.TH "NVME\-ANA\-LOG" "1" "04/24/2020" "NVMe" "NVMe Manual"
11+
.\" -----------------------------------------------------------------
12+
.\" * Define some portability stuff
13+
.\" -----------------------------------------------------------------
14+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15+
.\" http://bugs.debian.org/507673
16+
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17+
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18+
.ie \n(.g .ds Aq \(aq
19+
.el .ds Aq '
20+
.\" -----------------------------------------------------------------
21+
.\" * set default formatting
22+
.\" -----------------------------------------------------------------
23+
.\" disable hyphenation
24+
.nh
25+
.\" disable justification (adjust text to left margin only)
26+
.ad l
27+
.\" -----------------------------------------------------------------
28+
.\" * MAIN CONTENT STARTS HERE *
29+
.\" -----------------------------------------------------------------
30+
.SH "NAME"
31+
nvme-ana-log \- Send NVMe ANA log page request, returns result and log
32+
.SH "SYNOPSIS"
33+
.sp
34+
.nf
35+
\fInvme ana\-log\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>]
36+
.fi
37+
.SH "DESCRIPTION"
38+
.sp
39+
Retrieves the NVMe Asymmetric Namespace Access log page from an NVMe device and provides the returned structure\&.
40+
.sp
41+
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0)\&.
42+
.sp
43+
On success, the returned ANA 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\&.
44+
.SH "OPTIONS"
45+
.PP
46+
\-o <format>, \-\-output\-format=<format>
47+
.RS 4
48+
Set the reporting format to
49+
\fInormal\fR,
50+
\fIjson\fR, or
51+
\fIbinary\fR\&. Only one output format can be used at a time\&.
52+
.RE
53+
.SH "EXAMPLES"
54+
.sp
55+
.RS 4
56+
.ie n \{\
57+
\h'-04'\(bu\h'+03'\c
58+
.\}
59+
.el \{\
60+
.sp -1
61+
.IP \(bu 2.3
62+
.\}
63+
Print the ANA log page in a human readable format:
64+
.RE
65+
.sp
66+
.if n \{\
67+
.RS 4
68+
.\}
69+
.nf
70+
# nvme ana\-log /dev/nvme0
71+
.fi
72+
.if n \{\
73+
.RE
74+
.\}
75+
.SH "NVME"
76+
.sp
77+
Part of the nvme\-user suite

0 commit comments

Comments
 (0)