From nobody Tue Oct 15 20:21:29 2024
X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1])
by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4XSlqY59zhz5YxFT;
Tue, 15 Oct 2024 20:21:29 +0000 (UTC)
(envelope-from git@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 "R11" (verified OK))
by mx1.freebsd.org (Postfix) with ESMTPS id 4XSlqY3KWkz4vgR;
Tue, 15 Oct 2024 20:21:29 +0000 (UTC)
(envelope-from git@FreeBSD.org)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim;
t=1729023689;
h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
to:to:cc:mime-version:mime-version:content-type:content-type:
content-transfer-encoding:content-transfer-encoding;
bh=gzjlJbcC1K8KJPEIJwLSMmHlkz+7CCyCrwnBzDBjzSA=;
b=QLbrVQfagNXvRTgFxjmoDO0XIrGqSAyTEyGwbHnZlIZhuo18DFafinEP9hoSaoTu6mdC+X
186EzVJAuVCrDJaxyy4EidFWAFSan3MmZqYeoH5VzQoAhKbwVKVdjpBmaAWOONQja7n4/u
pbPdHr1Ea7PC2Hc6zehhxB2LI5+aDlgUGA84XQWMzWmDxYHgqB2H9au/0uDkWIig7y2/41
WSRnA+caW+6ctpSM/1eXGMTcYjbgNcta89xZ8iPtDlsWVDXaib8ZZzbD6irJRkiuZr2/MM
IuXLwS+/Xz+cMLMhibhqUdOJXZ9ryIekQozKuAz+4MgILF2jYyIfRt6prqr82A==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org;
s=dkim; t=1729023689;
h=from:from:reply-to:subject:subject:date:date:message-id:message-id:
to:to:cc:mime-version:mime-version:content-type:content-type:
content-transfer-encoding:content-transfer-encoding;
bh=gzjlJbcC1K8KJPEIJwLSMmHlkz+7CCyCrwnBzDBjzSA=;
b=X+A8YAPrH3f5SuRSyupsduAaDK3MYDy1aDHGwn7wtVBfgtGS0MVaGB5NlKWfn44RHgnVDX
Y/BnE9PppX/Nxn3UVJAjYy0/61QCiIu2po3na+zNbYykHm7hPciPJrDuZR+sUKNhBTms5W
/Tao0ZbQZO2H8WBkSo/23xKdSPxJSb7QlYDOzm6/caTDqcKuDtVfbRqzS7/68JCOQNjqVN
rAsC3tOhp45OgbZUaTSKxXndzZRUPmPqlwpnVWZ20sSo21h41zDbSRLf+DI276YXLXVEt3
aW6YOhzpH7pTWVyeWpyMw37GSd1AqHZO4vCdK49HaR3oLqZ7HRjM9RGHjFh/fA==
ARC-Authentication-Results: i=1;
mx1.freebsd.org;
none
ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1729023689; a=rsa-sha256; cv=none;
b=jbz8HcHBaWDF58+e+nufwX5fZKsNy3NnE5iMdHNpPgwVSsMRKGPL7RvGXSJCfQfJYziLQ4
vBtaMgP/NuiUUxSUqyrax8zLk+Df24WKLr0jG228eWDKdDXBw6TY/8qtJDB8Ohv2LZAbae
Iyy/QUzvln4aptL/ti7vYGsi03h8MMd39I7sGszXBbEVn4wPvK8zMV1HduXdYvhhVP+ctc
hVLYfoDERwVnBofonwpTkPOtyFRHHeMHaD/19XyGmB/Pkd9t3iEEMts3ty7Rg2lHi8cMj8
jKCqq0eNZZienSoDXipuf2R+jZ7vYhrrES9sipIWY6UF6w94cw+ZTauvyIC/9g==
Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5])
(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 did not present a certificate)
by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4XSlqY2fsRzc8H;
Tue, 15 Oct 2024 20:21:29 +0000 (UTC)
(envelope-from git@FreeBSD.org)
Received: from gitrepo.freebsd.org ([127.0.1.44])
by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 49FKLT5R029665;
Tue, 15 Oct 2024 20:21:29 GMT
(envelope-from git@gitrepo.freebsd.org)
Received: (from git@localhost)
by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 49FKLTNr029662;
Tue, 15 Oct 2024 20:21:29 GMT
(envelope-from git)
Date: Tue, 15 Oct 2024 20:21:29 GMT
Message-Id: <202410152021.49FKLTNr029662@gitrepo.freebsd.org>
To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org,
dev-commits-src-main@FreeBSD.org
From: Mitchell Horne <mhorne@FreeBSD.org>
Subject: git: a51584a2d2fb - main - manuals: Fix some "missing
section argument"
List-Id: Commit messages for the main branch of the src repository <dev-commits-src-main.freebsd.org>
List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main
List-Help: <mailto:dev-commits-src-main+help@freebsd.org>
List-Post: <mailto:dev-commits-src-main@freebsd.org>
List-Subscribe: <mailto:dev-commits-src-main+subscribe@freebsd.org>
List-Unsubscribe: <mailto:dev-commits-src-main+unsubscribe@freebsd.org>
X-BeenThere: dev-commits-src-main@freebsd.org
Sender: owner-dev-commits-src-main@FreeBSD.org
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
X-Git-Committer: mhorne
X-Git-Repository: src
X-Git-Refname: refs/heads/main
X-Git-Reftype: branch
X-Git-Commit: a51584a2d2fb3731a68eaf93b59e14227e572427
Auto-Submitted: auto-generated
The branch main has been updated by mhorne:
URL: https://cgit.FreeBSD.org/src/commit/?id=a51584a2d2fb3731a68eaf93b59e14227e572427
commit a51584a2d2fb3731a68eaf93b59e14227e572427
Author: Graham Percival <gperciva@tarsnap.com>
AuthorDate: 2024-10-14 02:24:00 +0000
Commit: Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2024-10-15 20:20:55 +0000
manuals: Fix some "missing section argument"
These were reported by `mandoc -T lint ...` as warnings.
Signed-off-by: Graham Percival <gperciva@tarsnap.com>
Reviewed by: mhorne, Alexander Ziaee <concussious.bugzilla@runbox.com>
Sponsored by: Tarsnap Backup Inc.
Pull Request: https://github.com/freebsd/freebsd-src/pull/1467
---
lib/libdevctl/devctl.3 | 2 +-
lib/libthr/libthr.3 | 2 +-
share/man/man4/disk.4 | 2 +-
share/man/man4/ng_iface.4 | 4 ++--
share/man/man4/ng_nat.4 | 2 +-
share/man/man4/qat.4 | 2 +-
share/man/man4/watchdog.4 | 8 ++++----
share/man/man9/VOP_ADVISE.9 | 2 +-
share/man/man9/VOP_ALLOCATE.9 | 2 +-
share/man/man9/contigmalloc.9 | 2 +-
share/man/man9/osd.9 | 2 +-
11 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/lib/libdevctl/devctl.3 b/lib/libdevctl/devctl.3
index a6823a0b3c6a..c8a4704825c2 100644
--- a/lib/libdevctl/devctl.3
+++ b/lib/libdevctl/devctl.3
@@ -209,7 +209,7 @@ method to construct the path.
The
.Fa buffer
pointer is updated with an allocated buffer that must be freed with
-.Xr free .
+.Xr free 3 .
.Pp
The
.Fn devctl_freeze
diff --git a/lib/libthr/libthr.3 b/lib/libthr/libthr.3
index 6d33f4c378ce..35a7467eec14 100644
--- a/lib/libthr/libthr.3
+++ b/lib/libthr/libthr.3
@@ -217,7 +217,7 @@ recycle it at any moment, making this sysctl less useful than it sounds.
.It Dv kern.ipc.umtx_max_robust
The maximal number of robust mutexes allowed for one thread.
The kernel will not unlock more mutexes than specified, see
-.Xr _umtx_op
+.Xr _umtx_op 2
for more details.
The default value is large enough for most useful applications.
.It Dv debug.umtx.robust_faults_verbose
diff --git a/share/man/man4/disk.4 b/share/man/man4/disk.4
index a6316d3fd268..97eeb9b718d4 100644
--- a/share/man/man4/disk.4
+++ b/share/man/man4/disk.4
@@ -57,7 +57,7 @@ Operations to block devices such as
.Xr lseek 2 ,
.Xr read 2 ,
and
-.Xr write
+.Xr write 2
may only be performed at file offsets that are integral multiple of
this size.
.It Dv DIOCGMEDIASIZE
diff --git a/share/man/man4/ng_iface.4 b/share/man/man4/ng_iface.4
index 0579028b4c74..e2dee22b67b9 100644
--- a/share/man/man4/ng_iface.4
+++ b/share/man/man4/ng_iface.4
@@ -153,8 +153,8 @@ to the desired level of nesting.
.Xr netgraph 4 ,
.Xr ng_cisco 4 ,
.Xr ifconfig 8 ,
-.Xr ngctl 8
-.Xr sysctl
+.Xr ngctl 8 ,
+.Xr sysctl 8
.Sh HISTORY
The
.Nm iface
diff --git a/share/man/man4/ng_nat.4 b/share/man/man4/ng_nat.4
index 53cd841a7392..bf9ec4052733 100644
--- a/share/man/man4/ng_nat.4
+++ b/share/man/man4/ng_nat.4
@@ -265,7 +265,7 @@ In case of
.Nm
failed to retrieve a certain counter
from its
-.Xr libalias
+.Xr libalias 3
instance, the corresponding field is returned as
.Va UINT32_MAX .
.It Dv NGM_NAT_SET_DLT Pq Ic setdlt
diff --git a/share/man/man4/qat.4 b/share/man/man4/qat.4
index 02be0837ce54..3d8c0cd32664 100644
--- a/share/man/man4/qat.4
+++ b/share/man/man4/qat.4
@@ -105,7 +105,7 @@ Following variables may be used to reconfigure the QAT device.\&
For configuration persistence those variables may be set before loading the driver, either via
.Xr kenv 1
or
-.Xr loader.conf(5).
+.Xr loader.conf 5 .
The device specific configuration options are prefixed with
.Va dev.qat.X\&.
where X is the device number.
diff --git a/share/man/man4/watchdog.4 b/share/man/man4/watchdog.4
index 2cd66bb8ba85..b74640de8469 100644
--- a/share/man/man4/watchdog.4
+++ b/share/man/man4/watchdog.4
@@ -42,7 +42,7 @@ supports several optional
.Xr ioctl 2
calls for configuration, and
responds to a single operational
-.Xr ioctl
+.Xr ioctl 2
call,
.Dv WDIOCPATPAT .
It takes a single argument which represents a timeout value specified as a
@@ -84,7 +84,7 @@ The watchdog might
still be armed!
.Pp
The optional configuration
-.Xr ioctl
+.Xr ioctl 2
commands are listed here, along with the type of the parameter used.
Examples of their use can be found in
.Xr watchdogd 8 .
@@ -127,7 +127,7 @@ printf(9)
.Sh RETURN VALUES
The
.Dv WDIOCPATPAT
-.Xr ioctl
+.Xr ioctl 2
returns zero on success and non-zero on failure.
.Bl -tag -width Er
.It Bq Er EOPNOTSUPP
@@ -141,7 +141,7 @@ Invalid flag combination passed.
.El
.Pp
The configuration
-.Xr ioctl
+.Xr ioctl 2
operations return zero on success and non-zero on failure.
.Sh EXAMPLES
.Bd -literal -offset indent
diff --git a/share/man/man9/VOP_ADVISE.9 b/share/man/man9/VOP_ADVISE.9
index 3decc0c2eac8..c6e8791615ce 100644
--- a/share/man/man9/VOP_ADVISE.9
+++ b/share/man/man9/VOP_ADVISE.9
@@ -39,7 +39,7 @@
.Sh DESCRIPTION
This call applies advice for a range of a file's data.
It is used to implement the
-.Xr posix_fadvise
+.Xr posix_fadvise 2
system call.
.Pp
Its arguments are:
diff --git a/share/man/man9/VOP_ALLOCATE.9 b/share/man/man9/VOP_ALLOCATE.9
index fce2ea183273..4fcbe773f236 100644
--- a/share/man/man9/VOP_ALLOCATE.9
+++ b/share/man/man9/VOP_ALLOCATE.9
@@ -45,7 +45,7 @@
.Sh DESCRIPTION
This call allocates storage for a range of offsets in a file.
It is used to implement the
-.Xr posix_fallocate
+.Xr posix_fallocate 2
system call.
.Pp
Its arguments are:
diff --git a/share/man/man9/contigmalloc.9 b/share/man/man9/contigmalloc.9
index edbcb1d60942..2e5d55ae8ba1 100644
--- a/share/man/man9/contigmalloc.9
+++ b/share/man/man9/contigmalloc.9
@@ -105,7 +105,7 @@ The
.Fn contigfree
function is deprecated.
Use
-.Xr free(9)
+.Xr free 9
instead.
.Sh IMPLEMENTATION NOTES
The
diff --git a/share/man/man9/osd.9 b/share/man/man9/osd.9
index 82f279ef17f4..95547f5211c2 100644
--- a/share/man/man9/osd.9
+++ b/share/man/man9/osd.9
@@ -396,7 +396,7 @@ API.
.Pp
.Fn osd_get
only acquires an
-.Xr rmlock
+.Xr rmlock 9
in read mode, therefore making it safe to use in the majority of contexts within
the kernel including most fast paths.
.Sh RETURN VALUES