From owner-svn-src-all@freebsd.org Sat Dec 19 11:47:39 2020 Return-Path: Delivered-To: svn-src-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 68E6C4C41EC; Sat, 19 Dec 2020 11:47:39 +0000 (UTC) (envelope-from gbe@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4CykVz2Xt2z3LYp; Sat, 19 Dec 2020 11:47:39 +0000 (UTC) (envelope-from gbe@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 459111CE91; Sat, 19 Dec 2020 11:47:39 +0000 (UTC) (envelope-from gbe@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id 0BJBldw2082713; Sat, 19 Dec 2020 11:47:39 GMT (envelope-from gbe@FreeBSD.org) Received: (from gbe@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id 0BJBldf3082712; Sat, 19 Dec 2020 11:47:39 GMT (envelope-from gbe@FreeBSD.org) Message-Id: <202012191147.0BJBldf3082712@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: gbe set sender to gbe@FreeBSD.org using -f From: Gordon Bergling Date: Sat, 19 Dec 2020 11:47:39 +0000 (UTC) To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r368802 - head/sbin/nvmecontrol X-SVN-Group: head X-SVN-Commit-Author: gbe X-SVN-Commit-Paths: head/sbin/nvmecontrol X-SVN-Commit-Revision: 368802 X-SVN-Commit-Repository: base MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-src-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: "SVN commit messages for the entire src tree \(except for " user" and " projects" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 19 Dec 2020 11:47:39 -0000 Author: gbe (doc committer) Date: Sat Dec 19 11:47:38 2020 New Revision: 368802 URL: https://svnweb.freebsd.org/changeset/base/368802 Log: 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 Modified: head/sbin/nvmecontrol/nvmecontrol.8 Modified: head/sbin/nvmecontrol/nvmecontrol.8 ============================================================================== --- head/sbin/nvmecontrol/nvmecontrol.8 Sat Dec 19 11:03:54 2020 (r368801) +++ head/sbin/nvmecontrol/nvmecontrol.8 Sat Dec 19 11:47:38 2020 (r368802) @@ -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