From a2bd3819aa1376ad4827c467317475bab181157d Mon Sep 17 00:00:00 2001 From: Hans Rosenfeld Date: Fri, 13 May 2016 18:49:45 +0200 Subject: [PATCH] 7376 nvme(7d) manpage cleanup Reviewed by: Yuri Pankov Reviewed by: Jean McCormack Reviewed by: Robert Mustacchi Approved by: Garrett D'Amore --- usr/src/man/man7d/nvme.7d | 39 ++++++++++++++++++++++----------------- 1 file changed, 22 insertions(+), 17 deletions(-) diff --git a/usr/src/man/man7d/nvme.7d b/usr/src/man/man7d/nvme.7d index fafe4ed82efe..de3635b96d85 100644 --- a/usr/src/man/man7d/nvme.7d +++ b/usr/src/man/man7d/nvme.7d @@ -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 @@ -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. @@ -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 .