Date: Sun, 3 May 2020 10:15:58 +0000 (UTC) From: Benedict Reuschling <bcr@FreeBSD.org> To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r360603 - in head/share/man: man3 man5 man7 man9 Message-ID: <202005031015.043AFwu4071860@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: bcr (doc committer) Date: Sun May 3 10:15:58 2020 New Revision: 360603 URL: https://svnweb.freebsd.org/changeset/base/360603 Log: Fix various, mostly minor errors in man pages like: - Abbreviated month name in .Dd - position of HISTORY section - alphabetical ordering within SEE ALSO section - adding .Ed before .Sh DESCRIPTION - remove trailing whitespaces - Line break after a sentence stop - Use BSD OS macros instead of hardcoded strings No .Dd bumps as there was no actual content change made in any of these pages. Submitted by: Gordon Bergling gbergling_gmail.com Approved by: bcr Differential Revision: https://reviews.freebsd.org/D24591 Modified: head/share/man/man3/bitstring.3 head/share/man/man3/sigevent.3 head/share/man/man3/timeradd.3 head/share/man/man5/cd9660.5 head/share/man/man5/elf.5 head/share/man/man5/fstab.5 head/share/man/man7/arch.7 head/share/man/man9/DECLARE_MODULE.9 head/share/man/man9/atomic.9 head/share/man/man9/bhnd.9 head/share/man/man9/bus_dma.9 head/share/man/man9/dpcpu.9 head/share/man/man9/getenv.9 head/share/man/man9/iflib.9 head/share/man/man9/kern_testfrwk.9 head/share/man/man9/ofw_graph.9 Modified: head/share/man/man3/bitstring.3 ============================================================================== --- head/share/man/man3/bitstring.3 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man3/bitstring.3 Sun May 3 10:15:58 2020 (r360603) @@ -58,7 +58,7 @@ .\" @(#)bitstring.3 8.1 (Berkeley) 7/19/93 .\" $FreeBSD$ .\" -.Dd Nov 18, 2019 +.Dd November 18, 2019 .Dt BITSTRING 3 .Os .Sh NAME Modified: head/share/man/man3/sigevent.3 ============================================================================== --- head/share/man/man3/sigevent.3 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man3/sigevent.3 Sun May 3 10:15:58 2020 (r360603) @@ -119,13 +119,13 @@ notifications must link against the .Xr mq_notify 2 , .Xr timer_create 2 , .Xr siginfo 3 -.Sh HISTORY -The -.Va sigevent -structure first appeared in -.Fx 3.3 . .Sh STANDARDS The .Vt struct sigevent type conforms to .St -p1003.1-2004 . +.Sh HISTORY +The +.Va sigevent +structure first appeared in +.Fx 3.3 . Modified: head/share/man/man3/timeradd.3 ============================================================================== --- head/share/man/man3/timeradd.3 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man3/timeradd.3 Sun May 3 10:15:58 2020 (r360603) @@ -146,8 +146,8 @@ using the comparison operator given in .Fa CMP , and return the result of that comparison. .Sh SEE ALSO -.Xr gettimeofday 2 , -.Xr clock_gettime 2 +.Xr clock_gettime 2 , +.Xr gettimeofday 2 .Sh HISTORY The .Fn timeradd Modified: head/share/man/man5/cd9660.5 ============================================================================== --- head/share/man/man5/cd9660.5 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man5/cd9660.5 Sun May 3 10:15:58 2020 (r360603) @@ -42,6 +42,7 @@ module at boot time, place the following line in .Xr loader.conf 5 : .Bd -literal -offset indent cd9660_load="YES" +.Ed .Sh DESCRIPTION The .Nm Modified: head/share/man/man5/elf.5 ============================================================================== --- head/share/man/man5/elf.5 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man5/elf.5 Sun May 3 10:15:58 2020 (r360603) @@ -1323,7 +1323,7 @@ Request that address randomization (ASLR) not be perfo See .Xr security 7 . .It NT_FREEBSD_FCTL_PROTMAX_DISABLE Pq Value: 0x02 -Request that +Request that .Xr mmap 2 calls not set PROT_MAX to the initial value of the .Fa prot Modified: head/share/man/man5/fstab.5 ============================================================================== --- head/share/man/man5/fstab.5 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man5/fstab.5 Sun May 3 10:15:58 2020 (r360603) @@ -254,7 +254,7 @@ To delay .Nm swapon for a device until after .Nm savecore -has copied the crash dump to another location, use the +has copied the crash dump to another location, use the .Dq late option. For vnode-backed swap spaces, Modified: head/share/man/man7/arch.7 ============================================================================== --- head/share/man/man7/arch.7 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man7/arch.7 Sun May 3 10:15:58 2020 (r360603) @@ -450,7 +450,9 @@ is defined to be mips for all the flavors of mips that since we support them all with a shared set of sources. While amd64 and i386 are closely related, MACHINE_CPUARCH is not x86 for them. -The FreeBSD source base supports amd64 and i386 with two +The +.Fx +source base supports amd64 and i386 with two distinct source bases living in subdirectories named amd64 and i386 (though behind the scenes there's some sharing that fits into this framework). Modified: head/share/man/man9/DECLARE_MODULE.9 ============================================================================== --- head/share/man/man9/DECLARE_MODULE.9 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man9/DECLARE_MODULE.9 Sun May 3 10:15:58 2020 (r360603) @@ -66,10 +66,11 @@ This declaration should be used by modules which depen the stable kernel KBI (such as ABI emulators or hypervisors that rely on internal kernel structures). .Fn DECLARE_MODULE -will behave like +will behave like .Fn DECLARE_MODULE_TIED -when compiled with modules built with the kernel. This allows locks and -other synchronization primitives to be inlined safely. +when compiled with modules built with the kernel. +This allows locks and other synchronization primitives +to be inlined safely. .Pp The arguments are: .Bl -tag -width indent Modified: head/share/man/man9/atomic.9 ============================================================================== --- head/share/man/man9/atomic.9 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man9/atomic.9 Sun May 3 10:15:58 2020 (r360603) @@ -272,7 +272,9 @@ In C11, a release fence by one thread synchronizes wit another thread when an atomic load that is prior to the acquire fence (by program order) reads the value written by an atomic store that is subsequent to the release fence. -In constrast, in FreeBSD, because of the atomicity of ordinary, naturally +In constrast, in +.Fx , +because of the atomicity of ordinary, naturally aligned loads and stores, fences can also be synchronized by ordinary loads and stores. This simplifies the implementation and use of some synchronization Modified: head/share/man/man9/bhnd.9 ============================================================================== --- head/share/man/man9/bhnd.9 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man9/bhnd.9 Sun May 3 10:15:58 2020 (r360603) @@ -857,9 +857,9 @@ The arguments are as follows: .It Fa dev The device requesting ownership of the resources. .It Fa rs -A standard bus resource specification. If all requested resources, are -successfully allocated, this will be updated with the allocated resource -identifiers. +A standard bus resource specification. +If all requested resources, are successfully allocated, +this will be updated with the allocated resource identifiers. .It Fa res If all requested resources are successfully allocated, this will be populated with the allocated Modified: head/share/man/man9/bus_dma.9 ============================================================================== --- head/share/man/man9/bus_dma.9 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man9/bus_dma.9 Sun May 3 10:15:58 2020 (r360603) @@ -685,7 +685,7 @@ on success. .It Fn bus_dma_template_init "*template" "parent" Initializes a .Fa bus_dma_template_t -structure and associates it with an optional +structure and associates it with an optional .Fa parent . The .Fa parent Modified: head/share/man/man9/dpcpu.9 ============================================================================== --- head/share/man/man9/dpcpu.9 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man9/dpcpu.9 Sun May 3 10:15:58 2020 (r360603) @@ -162,4 +162,4 @@ was first introduced by in .Fx 8.0 . This manual page was written by -.An Robert N. M. Watson. +.An Robert N. M. Watson . Modified: head/share/man/man9/getenv.9 ============================================================================== --- head/share/man/man9/getenv.9 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man9/getenv.9 Sun May 3 10:15:58 2020 (r360603) @@ -185,7 +185,7 @@ function stores a copy of the kernel environment varia in the buffer described by .Fa data and -.Fa size. +.Fa size . If the variable does not exist, zero is returned. If the variable exists, Modified: head/share/man/man9/iflib.9 ============================================================================== --- head/share/man/man9/iflib.9 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man9/iflib.9 Sun May 3 10:15:58 2020 (r360603) @@ -7,7 +7,8 @@ .Nd Network Interface Driver Framework .Sh DESCRIPTION .Nm -is a framework for writing network interface drivers for FreeBSD. +is a framework for writing network interface drivers for +.Fx . It is designed to remove a large amount of the boilerplate that is often needed for modern network interface devices, allowing driver authors to focus on the specific code needed for their hardware. @@ -39,4 +40,3 @@ based drivers. .Xr ifnet 9 .Sh AUTHORS .An Benno Rice Aq Mt benno@FreeBSD.org - Modified: head/share/man/man9/kern_testfrwk.9 ============================================================================== --- head/share/man/man9/kern_testfrwk.9 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man9/kern_testfrwk.9 Sun May 3 10:15:58 2020 (r360603) @@ -36,7 +36,9 @@ kld_load kern_testfrwk .\" out and replaced. -CEM So what is this sys/tests directory in the kernel all about? .Pp -Have you ever wanted to test a part of the FreeBSD kernel in some way and you +Have you ever wanted to test a part of the +.Fx +kernel in some way and you had no real way from user-land to make what you want to occur happen? Say an error path or situation where locking occurs in a particular manner that happens only once in a blue moon? Modified: head/share/man/man9/ofw_graph.9 ============================================================================== --- head/share/man/man9/ofw_graph.9 Sun May 3 09:54:19 2020 (r360602) +++ head/share/man/man9/ofw_graph.9 Sun May 3 10:15:58 2020 (r360603) @@ -60,7 +60,8 @@ It will first check node named .Fa port@idx and then fallback on checking the .Fa ports -child for a child node matching the id. If no ports matching +child for a child node matching the id. +If no ports matching .Fa idx is found the function return 0. .Pp @@ -72,8 +73,8 @@ return the endpoint with id .Fa idx . It will first check if there is a single child named .Fa endpoint -and returns it if there is. If there is multiple endpoints it will check -the +and returns it if there is. +If there is multiple endpoints it will check the .Fa reg property and returns the correct .Fa phandle_t @@ -91,10 +92,11 @@ phandle or 0 if none. .Fn ofw_graph_get_device_by_port_ep returns the device associated with the port and endpoint or .Fa NULL -if none. The device driver should have called +if none. +The device driver should have called .Fn OF_device_register_xref before. -.Fn +.Fn .Sh HISTORY The .Nm ofw_graph
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202005031015.043AFwu4071860>