git: 320686674b3c - main - Fix a slew of mdoc warnings/errors.
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Tue, 12 Apr 2022 21:53:56 UTC
The branch main has been updated by brueffer:
URL: https://cgit.FreeBSD.org/src/commit/?id=320686674b3c8ce3ffe135c421a22d063917ee46
commit 320686674b3c8ce3ffe135c421a22d063917ee46
Author: Christian Brueffer <brueffer@FreeBSD.org>
AuthorDate: 2022-04-12 21:52:54 +0000
Commit: Christian Brueffer <brueffer@FreeBSD.org>
CommitDate: 2022-04-12 21:53:48 +0000
Fix a slew of mdoc warnings/errors.
---
share/man/man3/pthread_set_name_np.3 | 6 +++---
share/man/man3/pthread_testcancel.3 | 1 -
share/man/man9/OF_child.9 | 1 -
share/man/man9/OF_device_from_xref.9 | 1 -
share/man/man9/OF_finddevice.9 | 4 ++--
share/man/man9/OF_getprop.9 | 3 +--
share/man/man9/OF_node_from_xref.9 | 3 +--
share/man/man9/OF_package_to_path.9 | 1 -
share/man/man9/VOP_SETLABEL.9 | 3 +--
share/man/man9/atomic.9 | 4 ++--
share/man/man9/backlight.9 | 2 +-
share/man/man9/crypto_buffer.9 | 2 +-
share/man/man9/crypto_driver.9 | 1 -
share/man/man9/crypto_request.9 | 3 +--
share/man/man9/dev_refthread.9 | 4 ++--
share/man/man9/drbr.9 | 2 +-
share/man/man9/epoch.9 | 2 +-
share/man/man9/fdt_pinctrl.9 | 2 +-
share/man/man9/hz.9 | 2 +-
share/man/man9/iflibdi.9 | 1 -
share/man/man9/iflibtxrx.9 | 1 -
share/man/man9/ifnet.9 | 1 -
share/man/man9/kern_reboot.9 | 6 +++---
share/man/man9/mac.9 | 2 +-
share/man/man9/mod_cc.9 | 3 ++-
share/man/man9/namei.9 | 2 +-
share/man/man9/nvmem.9 | 4 ++--
share/man/man9/ofw_graph.9 | 4 +---
share/man/man9/owll.9 | 2 +-
share/man/man9/pmap_zero_page.9 | 2 +-
share/man/man9/printf.9 | 4 ++--
share/man/man9/prng.9 | 1 -
share/man/man9/sglist.9 | 2 +-
share/man/man9/vrele.9 | 2 +-
34 files changed, 35 insertions(+), 49 deletions(-)
diff --git a/share/man/man3/pthread_set_name_np.3 b/share/man/man3/pthread_set_name_np.3
index 5fb627a5a182..5423ef898f58 100644
--- a/share/man/man3/pthread_set_name_np.3
+++ b/share/man/man3/pthread_set_name_np.3
@@ -30,7 +30,7 @@
.Sh NAME
.Nm pthread_get_name_np ,
.Nm pthread_getname_np ,
-.Nm pthread_set_name_np
+.Nm pthread_set_name_np ,
.Nm pthread_setname_np
.Nd set and retrieve the thread name
.Sh LIBRARY
@@ -90,8 +90,8 @@ and
functions, all errors that may
appear inside are silently ignored.
.Sh SEE ALSO
-.Xr pthread_np 3 ,
-.Xr thr_set_name 2
+.Xr thr_set_name 2 ,
+.Xr pthread_np 3
.Sh STANDARDS
.Fn pthread_set_name_np
and
diff --git a/share/man/man3/pthread_testcancel.3 b/share/man/man3/pthread_testcancel.3
index 5d0efcb2d635..9ba1403dffdc 100644
--- a/share/man/man3/pthread_testcancel.3
+++ b/share/man/man3/pthread_testcancel.3
@@ -69,7 +69,6 @@ function creates a cancellation point in the calling thread.
The
.Fn pthread_testcancel
function has no effect if cancelability is disabled.
-.Pp
.Ss Cancelability States
The cancelability state of a thread determines the action taken upon
receipt of a cancellation request.
diff --git a/share/man/man9/OF_child.9 b/share/man/man9/OF_child.9
index 03036197f5ab..8227401f5f14 100644
--- a/share/man/man9/OF_child.9
+++ b/share/man/man9/OF_child.9
@@ -43,7 +43,6 @@
.Ft phandle_t
.Fn OF_peer "phandle_t node"
.Sh DESCRIPTION
-.Pp
.Fn OF_child
returns the phandle value of the first child of the
.Fa node .
diff --git a/share/man/man9/OF_device_from_xref.9 b/share/man/man9/OF_device_from_xref.9
index f6a483f9fd5c..c8c206afe777 100644
--- a/share/man/man9/OF_device_from_xref.9
+++ b/share/man/man9/OF_device_from_xref.9
@@ -43,7 +43,6 @@
.Ft phandle_t
.Fn OF_xref_from_device "device_t dev"
.Sh DESCRIPTION
-.Pp
When a device tree node references another node, the driver may
need to get a device_t instance associated with the referenced node.
For instance, an Ethernet driver accessing a PHY device.
diff --git a/share/man/man9/OF_finddevice.9 b/share/man/man9/OF_finddevice.9
index 30341e779bf2..d524a182f01c 100644
--- a/share/man/man9/OF_finddevice.9
+++ b/share/man/man9/OF_finddevice.9
@@ -52,8 +52,8 @@ Returns -1 if the path cannot be found in the tree.
}
.Ed
.Sh SEE ALSO
-.Xr OF_child 9
-.Xr OF_parent 9
+.Xr OF_child 9 ,
+.Xr OF_parent 9 ,
.Xr OF_peer 9
.Sh AUTHORS
.An -nosplit
diff --git a/share/man/man9/OF_getprop.9 b/share/man/man9/OF_getprop.9
index 9ad996f4395b..5d0607a0a3bf 100644
--- a/share/man/man9/OF_getprop.9
+++ b/share/man/man9/OF_getprop.9
@@ -83,7 +83,6 @@
.Fn OF_setprop "phandle_t node" "const char *propname" \
"const void *buf" "size_t len"
.Sh DESCRIPTION
-.Pp
Device nodes can have associated properties.
Properties consist of a name and a value.
A name is a human-readable string from 1 to 31 characters long.
@@ -345,7 +344,7 @@ cannot be created.
return;
.Ed
.Sh SEE ALSO
-.Xr OF_device_from_xref 9
+.Xr OF_device_from_xref 9 ,
.Xr OF_node_from_xref 9
.Sh AUTHORS
.An -nosplit
diff --git a/share/man/man9/OF_node_from_xref.9 b/share/man/man9/OF_node_from_xref.9
index fd4fae8c5375..41b683fac928 100644
--- a/share/man/man9/OF_node_from_xref.9
+++ b/share/man/man9/OF_node_from_xref.9
@@ -40,7 +40,6 @@
.Ft phandle_t
.Fn OF_xref_from_node "phandle_t node"
.Sh DESCRIPTION
-.Pp
Some OpenFirmware implementations (FDT, IBM) have a concept
of effective phandle or xrefs.
They are used to cross-reference device tree nodes.
@@ -92,7 +91,7 @@ the input value.
return;
.Ed
.Sh SEE ALSO
-.Xr OF_device_from_xref 9
+.Xr OF_device_from_xref 9 ,
.Xr OF_device_register_xref 9
.Sh AUTHORS
.An -nosplit
diff --git a/share/man/man9/OF_package_to_path.9 b/share/man/man9/OF_package_to_path.9
index 6726ccde9cf5..93ff504bfaae 100644
--- a/share/man/man9/OF_package_to_path.9
+++ b/share/man/man9/OF_package_to_path.9
@@ -37,7 +37,6 @@
.Ft ssize_t
.Fn OF_package_to_path "phandle_t node" "char *buf" "size_t len"
.Sh DESCRIPTION
-.Pp
.Fn OF_package_to_path
copies at most
.Fa len
diff --git a/share/man/man9/VOP_SETLABEL.9 b/share/man/man9/VOP_SETLABEL.9
index 8b7e54e515cc..6cfa7c4b15bb 100644
--- a/share/man/man9/VOP_SETLABEL.9
+++ b/share/man/man9/VOP_SETLABEL.9
@@ -85,7 +85,6 @@ These utility functions use
and
.Xr VOP_CLOSEEXTATTR 9
as required.
-.Pp
.Ss Locking and Crash Safety
In all cases, it is important that exclusive
.Xr vnode 9
@@ -122,7 +121,7 @@ other errors may also be possible.
.Xr VOP_WRITEXTATTR 9 ,
.Xr mac 9 ,
.Xr mount 9 ,
-.Xr vnode 9 ,
+.Xr vnode 9
.Sh AUTHORS
This manual page was written by
.An Robert Watson .
diff --git a/share/man/man9/atomic.9 b/share/man/man9/atomic.9
index ebc6ed791f37..784a776546de 100644
--- a/share/man/man9/atomic.9
+++ b/share/man/man9/atomic.9
@@ -297,11 +297,11 @@ For example, they can be used to avoid executing a memory barrier until a
memory access shows that some condition is satisfied.
.Ss Interrupt Fence Operations
The
-.Fn atomic_interrupt_fence()
+.Fn atomic_interrupt_fence
function establishes ordering between its call location and any interrupt
handler executing on the same CPU.
It is modeled after the similar C11 function
-.Fn atomic_signal_fence() ,
+.Fn atomic_signal_fence ,
and adapted for the kernel environment.
.Ss Multiple Processors
In multiprocessor systems, the atomicity of the atomic operations on memory
diff --git a/share/man/man9/backlight.9 b/share/man/man9/backlight.9
index d0c09f75373b..3c6bca732205 100644
--- a/share/man/man9/backlight.9
+++ b/share/man/man9/backlight.9
@@ -30,7 +30,7 @@
.Nm backlight_register ,
.Nm backlight_destroy ,
.Nm BACKLIGHT_GET_STATUS ,
-.Nm BACKLIGHT_SET_STATUS ,
+.Nm BACKLIGHT_SET_STATUS
.Nd BACKLIGHT methods
.Sh SYNOPSIS
.Cd "device backlight"
diff --git a/share/man/man9/crypto_buffer.9 b/share/man/man9/crypto_buffer.9
index 87cdf53b1abd..1e31cfec7879 100644
--- a/share/man/man9/crypto_buffer.9
+++ b/share/man/man9/crypto_buffer.9
@@ -30,7 +30,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd Feburary 11, 2022
+.Dd February 11, 2022
.Dt CRYPTO_BUFFER 9
.Os
.Sh NAME
diff --git a/share/man/man9/crypto_driver.9 b/share/man/man9/crypto_driver.9
index b0032e7fa385..a0587f4b5f83 100644
--- a/share/man/man9/crypto_driver.9
+++ b/share/man/man9/crypto_driver.9
@@ -291,7 +291,6 @@ indicates that the driver is able to handle symmetric requests passed to
.Fn CRYPTODEV_PROCESS .
.El
.Pp
-.Pp
.Fn hmac_init_ipad
prepares an authentication context to generate the inner hash of an HMAC.
.Fa axf
diff --git a/share/man/man9/crypto_request.9 b/share/man/man9/crypto_request.9
index eb38fdeeffa3..1b7379245608 100644
--- a/share/man/man9/crypto_request.9
+++ b/share/man/man9/crypto_request.9
@@ -454,7 +454,6 @@ invoked in the same order that requests were queued to the session via
.Fn crypto_dispatch .
This flag is used by IPsec to ensure that decrypted network packets are
passed up the network stack in roughly the same order they were received.
-.Pp
.Ss Other Request Fields
In addition to the fields and flags enumerated above,
.Vt struct cryptop
@@ -537,7 +536,7 @@ was passed in
.Xr crypto 7 ,
.Xr crypto 9 ,
.Xr crypto_session 9 ,
-.Xr mbuf 9
+.Xr mbuf 9 ,
.Xr uio 9
.Sh BUGS
Not all drivers properly handle mixing session and per-request keys
diff --git a/share/man/man9/dev_refthread.9 b/share/man/man9/dev_refthread.9
index 74e8d69d150c..c6aa7d955230 100644
--- a/share/man/man9/dev_refthread.9
+++ b/share/man/man9/dev_refthread.9
@@ -145,8 +145,8 @@ and do not initialize the value pointed to by the
parameter in any way.
.Ef
.Sh SEE ALSO
-.Xr destroy_dev 9 ,
-.Xr devfs 5
+.Xr devfs 5 ,
+.Xr destroy_dev 9
.Sh CAVEATS
Do not invoke
.Fn dev_relthread
diff --git a/share/man/man9/drbr.9 b/share/man/man9/drbr.9
index eebc3a7df157..9c641cd0e841 100644
--- a/share/man/man9/drbr.9
+++ b/share/man/man9/drbr.9
@@ -36,7 +36,7 @@
.Nm drbr_dequeue_cond ,
.Nm drbr_flush ,
.Nm drbr_empty ,
-.Nm drbr_inuse ,
+.Nm drbr_inuse
.Nd network driver interface to buf_ring
.Sh SYNOPSIS
.In sys/param.h
diff --git a/share/man/man9/epoch.9 b/share/man/man9/epoch.9
index e81b715f872a..1f191211b041 100644
--- a/share/man/man9/epoch.9
+++ b/share/man/man9/epoch.9
@@ -43,7 +43,7 @@
.Nm epoch_call ,
.Nm epoch_drain_callbacks ,
.Nm in_epoch ,
-.Nm in_epoch_verbose ,
+.Nm in_epoch_verbose
.Nd kernel epoch based reclamation
.Sh SYNOPSIS
.In sys/param.h
diff --git a/share/man/man9/fdt_pinctrl.9 b/share/man/man9/fdt_pinctrl.9
index f4cb92368136..8f1f24a07a52 100644
--- a/share/man/man9/fdt_pinctrl.9
+++ b/share/man/man9/fdt_pinctrl.9
@@ -185,7 +185,7 @@ static device_method_t foo_methods[] = {
DRIVER_MODULE(foo, simplebus, foo_driver, foo_devclass, NULL, NULL);
.Ed
.Sh SEE ALSO
-.Xr fdt_pinctrl 4 ,
+.Xr fdt_pinctrl 4
.Sh AUTHORS
This manual page was written by
.An Oleksandr Tymoshenko .
diff --git a/share/man/man9/hz.9 b/share/man/man9/hz.9
index 73efcf3b0da3..081c9f6e0c4d 100644
--- a/share/man/man9/hz.9
+++ b/share/man/man9/hz.9
@@ -37,7 +37,7 @@
.Vt extern int hz;
.Vt extern int tick;
.Vt extern int stathz;
-.Vt extern int profhz; /* deprecated */
+.Vt extern int profhz; /* deprecated */
.Sh DESCRIPTION
.Fx
utilizes periodic, one-shot, global or per-CPU
diff --git a/share/man/man9/iflibdi.9 b/share/man/man9/iflibdi.9
index c37832ede6af..0d40333dd528 100644
--- a/share/man/man9/iflibdi.9
+++ b/share/man/man9/iflibdi.9
@@ -100,7 +100,6 @@ Each queue has its own transmit (iflib_txq_t) and receive (iflib_rxq_t) queue.
The transmit queue is used to hold packets while the interface is in the
process of sending another.
The receive queue is used to receive packets that are awaiting processing.
-.Pp
.Ss The if_ctx_t Structure
The fields of
.Vt "struct if_ctx_t"
diff --git a/share/man/man9/iflibtxrx.9 b/share/man/man9/iflibtxrx.9
index f99a91b05838..adb44def1d3f 100644
--- a/share/man/man9/iflibtxrx.9
+++ b/share/man/man9/iflibtxrx.9
@@ -61,7 +61,6 @@ primarily defined by the functions named above.
The if_pkt_info data structure contains statistics and identifying info
necessary for packet transmission.
While the data structure for packet receipt is the if_rxd_info structure.
-.Pp
.Ss The if_pkt_info Structure
The fields of
.Vt "struct if_pkt_info"
diff --git a/share/man/man9/ifnet.9 b/share/man/man9/ifnet.9
index 90a95106b1d5..d604a2092e19 100644
--- a/share/man/man9/ifnet.9
+++ b/share/man/man9/ifnet.9
@@ -218,7 +218,6 @@ Interfaces are also associated with an output queue, defined as a
.Vt "struct ifqueue" ;
this structure is used to hold packets while the interface is in the
process of sending another.
-.Pp
.Ss The ifnet Structure
The fields of
.Vt "struct ifnet"
diff --git a/share/man/man9/kern_reboot.9 b/share/man/man9/kern_reboot.9
index 587d4ab114db..fe8ccd7390c3 100644
--- a/share/man/man9/kern_reboot.9
+++ b/share/man/man9/kern_reboot.9
@@ -34,7 +34,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd Sept 23, 2021
+.Dd September 23, 2021
.Dt KERN_REBOOT 9
.Os
.Sh NAME
@@ -105,6 +105,6 @@ The
.Fn kern_reboot
function does not return.
.Sh SEE ALSO
-.Xr reboot 2
-.Xr EVENTHANDLER 9
+.Xr reboot 2 ,
+.Xr EVENTHANDLER 9 ,
.Xr vfs_unmountall 9
diff --git a/share/man/man9/mac.9 b/share/man/man9/mac.9
index 9357c1189bd7..8913321a2d38 100644
--- a/share/man/man9/mac.9
+++ b/share/man/man9/mac.9
@@ -163,7 +163,7 @@ for information on the MAC Framework APIs.
.Xr vaccess 9 ,
.Xr vaccess_acl_posix1e 9 ,
.Xr VFS 9 ,
-.Xr VOP_SETLABEL 9 .
+.Xr VOP_SETLABEL 9
.Rs
.%T "The FreeBSD Architecture Handbook"
.%U "https://docs.freebsd.org/en/books/arch-handbook/"
diff --git a/share/man/man9/mod_cc.9 b/share/man/man9/mod_cc.9
index 6bfb1eceed56..0a275d2da8e1 100644
--- a/share/man/man9/mod_cc.9
+++ b/share/man/man9/mod_cc.9
@@ -252,7 +252,8 @@ function.
This is because when switching from one congestion control
module to another the socket option code will preallocate memory for the
.Va cb_init
-function. If no memory is allocated by the modules
+function.
+If no memory is allocated by the modules
.Va cb_init
then the
.Va cc_data_sz
diff --git a/share/man/man9/namei.9 b/share/man/man9/namei.9
index b51b9c48a48a..f98646725fb3 100644
--- a/share/man/man9/namei.9
+++ b/share/man/man9/namei.9
@@ -39,7 +39,7 @@
.Sh NAME
.Nm namei ,
.Nm NDINIT ,
-.Nm NDFREE ,
+.Nm NDFREE
.Nd pathname translation and lookup operations
.Sh SYNOPSIS
.In sys/param.h
diff --git a/share/man/man9/nvmem.9 b/share/man/man9/nvmem.9
index 9dd7368c874c..fe06a98c29ce 100644
--- a/share/man/man9/nvmem.9
+++ b/share/man/man9/nvmem.9
@@ -26,12 +26,12 @@
.Dt nvmem 9
.Os
.Sh NAME
-.Nm nvmem
+.Nm nvmem ,
.Nm nvmem_get_cell_len ,
.Nm nvmem_read_cell_by_name ,
.Nm nvmem_read_cell_by_idx ,
.Nm nvmem_write_cell_by_name ,
-.Nm nvmem_write_cell_by_idx ,
+.Nm nvmem_write_cell_by_idx
.Sh SYNOPSIS
.Cd "options FDT"
.Cd "device nvmem"
diff --git a/share/man/man9/ofw_graph.9 b/share/man/man9/ofw_graph.9
index 0c121f7a05b2..becb5caffc1f 100644
--- a/share/man/man9/ofw_graph.9
+++ b/share/man/man9/ofw_graph.9
@@ -32,7 +32,7 @@
.Nm ofw_graph_get_endpoint_by_idx ,
.Nm ofw_graph_get_remote_endpoint ,
.Nm ofw_graph_get_remote_parent ,
-.Nm ofw_graph_get_device_by_port_ep ,
+.Nm ofw_graph_get_device_by_port_ep
.Nd Helpers for the graph bindings
.Sh SYNOPSIS
.In dev/ofw/openfirm.h
@@ -50,7 +50,6 @@
.Ft device_t
.Fn ofw_graph_get_device_by_port_ep "phandle_t node" "uint32_t port_id" "uin32_t ep_id"
.Sh DESCRIPTION
-.Pp
The ofw_graph functions are helpers to parse the DTS graph bindings
.Pp
.Fn ofw_graph_get_port_by_idx
@@ -96,7 +95,6 @@ if none.
The device driver should have called
.Fn OF_device_register_xref
before.
-.Fn
.Sh HISTORY
The
.Nm ofw_graph
diff --git a/share/man/man9/owll.9 b/share/man/man9/owll.9
index 715dd96c1e8c..a8b623a73a50 100644
--- a/share/man/man9/owll.9
+++ b/share/man/man9/owll.9
@@ -27,7 +27,7 @@
.Dt OWLL 9
.Os
.Sh NAME
-.Nm owll
+.Nm owll ,
.Nm OWLL_WRITE_ONE ,
.Nm OWLL_WRITE_ZERO ,
.Nm OWLL_READ_DATA ,
diff --git a/share/man/man9/pmap_zero_page.9 b/share/man/man9/pmap_zero_page.9
index f02b3a59bbba..52e76520ec40 100644
--- a/share/man/man9/pmap_zero_page.9
+++ b/share/man/man9/pmap_zero_page.9
@@ -30,7 +30,7 @@
.Os
.Sh NAME
.Nm pmap_zero_page ,
-.Nm pmap_zero_area ,
+.Nm pmap_zero_area
.Nd zero-fill a page using machine-dependent optimizations
.Sh SYNOPSIS
.In sys/param.h
diff --git a/share/man/man9/printf.9 b/share/man/man9/printf.9
index 1a3640871bd1..4d3a6fb8b2a5 100644
--- a/share/man/man9/printf.9
+++ b/share/man/man9/printf.9
@@ -53,7 +53,7 @@
.Fn vlog "int pri" "const char *fmt" "va_list ap"
.Sh DESCRIPTION
The
-.Xr printf 9
+.Nm
family of functions are similar to the
.Xr printf 3
family of functions.
@@ -82,7 +82,7 @@ Each of these related functions use the
parameter in the same manner as
.Xr printf 3 .
However,
-.Xr printf 9
+.Nm
adds two other conversion specifiers and omits one.
.Pp
The
diff --git a/share/man/man9/prng.9 b/share/man/man9/prng.9
index 63132c28c198..20cfcf910442 100644
--- a/share/man/man9/prng.9
+++ b/share/man/man9/prng.9
@@ -68,7 +68,6 @@ random numbers generated by the
.Xr random 4
kernel cryptographically secure random number generator subsystem, see
.Xr arc4random 9 .
-.Pp
.Bl -tag -width indent
.It Fn prng32
Generate a 32-bit integer uniformly distributed in [0, 2^32-1].
diff --git a/share/man/man9/sglist.9 b/share/man/man9/sglist.9
index 408d23573489..ec452194527b 100644
--- a/share/man/man9/sglist.9
+++ b/share/man/man9/sglist.9
@@ -35,7 +35,7 @@
.Nm sglist_append ,
.Nm sglist_append_bio ,
.Nm sglist_append_mbuf ,
-.Nm sglist_append_mbuf_epg,
+.Nm sglist_append_mbuf_epg ,
.Nm sglist_append_phys ,
.Nm sglist_append_sglist ,
.Nm sglist_append_single_mbuf ,
diff --git a/share/man/man9/vrele.9 b/share/man/man9/vrele.9
index 1eae4426e7ef..a0d6a1e3f0ac 100644
--- a/share/man/man9/vrele.9
+++ b/share/man/man9/vrele.9
@@ -68,7 +68,7 @@ The
is operationally equivalent to calling
.Xr VOP_UNLOCK 9
followed by
-.Xr vrele 9 ,
+.Fn vrele ,
with less overhead.
.Pp
The