Skip to content

Commit

Permalink
7376 nvme(7d) manpage cleanup
Browse files Browse the repository at this point in the history
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Jean McCormack <jean.mccormack@nexenta.com>
Reviewed by: Robert Mustacchi <rm@joyent.com>
Approved by: Garrett D'Amore <garrett@damore.org>
  • Loading branch information
Hans Rosenfeld committed Sep 29, 2016
1 parent d148d46 commit a2bd381
Showing 1 changed file with 22 additions and 17 deletions.
39 changes: 22 additions & 17 deletions usr/src/man/man7d/nvme.7d
Expand Up @@ -34,16 +34,19 @@ instance in the system.
.Sh CONFIGURATION
The
.Nm
driver can be configured by defining properties in the \fBnvme.conf\fR
file. The parameters are considered an unstable interface, subject to
change without notice. The following properties are currently
supported:
driver can be configured by defining properties in the
.Pa nvme.conf
file.
The parameters are considered an unstable interface, subject to
change without notice.
The following properties are currently supported:
.Bl -tag -width Va
.It Va strict-version
This can be set to 0 to allow
.Nm
to attach to devices supporting newer version of the NVMe
specification. The default value is 1, limiting
specification.
The default value is 1, limiting
.Nm
to work with devices up to specification version 1.0.
.It Va ignore-unknown-vendor-status
Expand All @@ -52,17 +55,18 @@ This can be set to 1 to allow
to continue operating even if it receives an unknown vendor command
status.
.It Va admin-queue-len
This is the number of entries in the admin command queue. Legal values
are between 16 and 4096, the default value is 256.
This is the number of entries in the admin command queue.
Legal values are between 16 and 4096, the default value is 256.
.It Va io-queue-len
This is the number of entries in each I/O command queue. Legal values
are between 16 and 65536, the default value is 1024.
This is the number of entries in each I/O command queue.
Legal values are between 16 and 65536, the default value is 1024.
.It Va async-event-limit
This is the maximum number of asynchronous event requests issued by
the driver. Asynchronous events are used to report error conditions.
the driver.
Asynchronous events are used to report error conditions.
The driver will never use more asynchronous events than this value, or
what the hardware supports if it is less, or what 1/10th of the admin
queue length if it is less.
what the hardware supports if it is less, or 1/10th of the admin queue
length if it is less.
.It Va volatile-write-cache-enable
This property can be set to 0 to disable the volatile write cache, if
the hardware supports it.
Expand All @@ -82,16 +86,17 @@ In the device minor nodes, the following substitutions may occur:
.It Va cn
A controller number, typically one for each
.Nm
device found. Controller numbers are dynamically assigned by the
system.
device found.
Controller numbers are dynamically assigned by the system.
.It Va tn
The target number, this corresponds to the namespace ID used by the
hardware. Namespace ID 0 is reserved, hence target numbers start with
1.
hardware.
Namespace ID 0 is reserved, hence target numbers start with 1.
.It Va sn
This is the
.Em slice
number, representing a subset of the disk. See
number, representing a subset of the disk.
See
.Xr dkio 7I .
.El
.
Expand Down

0 comments on commit a2bd381

Please sign in to comment.