Date: Sat, 2 Jan 2021 23:34:41 GMT From: Gordon Bergling <gbe@FreeBSD.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org Subject: git: f6065a1ee3f9 - stable/12 - MFC r368802: nvmecontrol(8): Fix a few mandoc related issues and add a SEE ALSO section Message-ID: <202101022334.102NYfO5046496@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch stable/12 has been updated by gbe (doc committer): URL: https://cgit.FreeBSD.org/src/commit/?id=f6065a1ee3f9eb3aa1ed2333a0f899fa17b56699 commit f6065a1ee3f9eb3aa1ed2333a0f899fa17b56699 Author: Gordon Bergling <gbe@FreeBSD.org> AuthorDate: 2020-12-19 11:47:38 +0000 Commit: Gordon Bergling <gbe@FreeBSD.org> CommitDate: 2021-01-02 23:32:56 +0000 MFC r368802: 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. (cherry picked from commit 9bca273d8496a078787ffbff18b9ae925e25cc36) --- sbin/nvmecontrol/nvmecontrol.8 | 14 +++++++++----- 1 file 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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202101022334.102NYfO5046496>