aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGordon Bergling <gbe@FreeBSD.org>2020-12-19 11:47:38 +0000
committerGordon Bergling <gbe@FreeBSD.org>2020-12-19 11:47:38 +0000
commit9bca273d8496a078787ffbff18b9ae925e25cc36 (patch)
treec78b945bd07a1189f9f4be5b723a8833d9776c11
parent7d0368ee3403378806dce84cb31b9a0cc389258d (diff)
downloadsrc-9bca273d8496a078787ffbff18b9ae925e25cc36.tar.gz
src-9bca273d8496a078787ffbff18b9ae925e25cc36.zip
nvmecontrol(8): Fix a few mandoc related issues and add a SEE ALSO section
- inserting missing end of block: Ss breaks Bl - skipping paragraph macro: Pp before Ss - referenced manual not found: Xr nvme 4 (2 times) - unknown standard specifier: St The The macro .St can only be used for standards known by mdoc(7). So add a SEE ALSO section and add a reference to the NVM Express Base Specification. MFC after: 2 weeks
Notes
Notes: svn path=/head/; revision=368802
-rw-r--r--sbin/nvmecontrol/nvmecontrol.814
1 files changed, 9 insertions, 5 deletions
diff --git a/sbin/nvmecontrol/nvmecontrol.8 b/sbin/nvmecontrol/nvmecontrol.8
index a9796cf735da..976532932a69 100644
--- a/sbin/nvmecontrol/nvmecontrol.8
+++ b/sbin/nvmecontrol/nvmecontrol.8
@@ -35,7 +35,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd April 30, 2020
+.Dd December 19, 2020
.Dt NVMECONTROL 8
.Os
.Sh NAME
@@ -205,7 +205,6 @@
.Sh DESCRIPTION
NVM Express (NVMe) is a storage protocol standard, for SSDs and other
high-speed storage devices over PCI Express.
-.Pp
.Ss identify
The identify commands reports information from the drive's
.Dv IDENTIFY_CONTROLLER
@@ -238,6 +237,7 @@ of
is used to retrieve the
.Dv IDENTIFY_CONTROLLER
data associated with that drive.
+.El
.Ss logpage
The logpage command knows how to print log pages of various types.
It also knows about vendor specific log pages from hgst/wdc and intel.
@@ -482,9 +482,7 @@ and
commands send NVMe commands to
either the administrative or the data part of the device.
These commands are expected to be compatible with nvme-cli.
-Please see
-.St The NVMe Standard
-for details.
+Please see the NVMe Standard for details.
.Bl -tag -width 16n
.It Fl o -opcode Ar opcode
Opcode to send.
@@ -674,6 +672,12 @@ linker set are added to the top-level commands.
The members of the
.Va logpage
linker set are added to the logpage parsers.
+.Sh SEE ALSO
+.Rs
+.%T The NVM Express Base Specification
+.%D June 10, 2019
+.%U https://nvmexpress.org/wp-content/uploads/NVM-Express-1_4-2019.06.10-Ratified.pdf
+.Re
.Sh HISTORY
The
.Nm