Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 4 Nov 2024 16:16:50 GMT
From:      Mitchell Horne <mhorne@FreeBSD.org>
To:        src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org
Subject:   git: e40097e01a08 - stable/14 - manuals: Fix some "missing section argument"
Message-ID:  <202411041616.4A4GGoSN010789@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch stable/14 has been updated by mhorne:

URL: https://cgit.FreeBSD.org/src/commit/?id=e40097e01a08db646f409cec81d04e8c5b92293e

commit e40097e01a08db646f409cec81d04e8c5b92293e
Author:     Graham Percival <gperciva@tarsnap.com>
AuthorDate: 2024-10-14 02:24:00 +0000
Commit:     Mitchell Horne <mhorne@FreeBSD.org>
CommitDate: 2024-11-04 16:15:01 +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
    
    (cherry picked from commit a51584a2d2fb3731a68eaf93b59e14227e572427)
---
 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/osd.9          | 2 +-
 10 files changed, 14 insertions(+), 14 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 6451ff0e7370..dfe0059263ee 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 b0fa0b0cbc92..03d1e6e956e7 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 f711d4d176d1..7663d4831464 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/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



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202411041616.4A4GGoSN010789>