From 109d3214d700b6a5031ba634c4abe2e75629f562 Mon Sep 17 00:00:00 2001 From: gjb Date: Tue, 29 May 2012 14:36:07 +0000 Subject: [PATCH] MFC r235693: Typo and mdoc(7) style fixes. PR: 168117 git-svn-id: svn://svn.freebsd.org/base/stable/8@236236 ccf9f872-aa2e-dd11-9fc8-001c23d0bc1f --- share/man/man9/BUF_ISLOCKED.9 | 2 +- share/man/man9/DB_COMMAND.9 | 2 +- share/man/man9/VOP_GETEXTATTR.9 | 4 ++-- share/man/man9/VOP_GETPAGES.9 | 2 +- share/man/man9/VOP_GETVOBJECT.9 | 2 +- share/man/man9/VOP_SETEXTATTR.9 | 2 +- share/man/man9/acl.9 | 2 +- share/man/man9/bus_generic_print_child.9 | 2 +- share/man/man9/bus_release_resource.9 | 2 +- share/man/man9/bus_space.9 | 3 ++- share/man/man9/byteorder.9 | 2 +- share/man/man9/devclass_get_maxunit.9 | 2 +- share/man/man9/device_find_child.9 | 2 +- share/man/man9/firmware.9 | 8 +++++--- share/man/man9/hashinit.9 | 2 +- share/man/man9/ieee80211_proto.9 | 2 +- share/man/man9/lock.9 | 2 +- share/man/man9/locking.9 | 5 ++--- share/man/man9/mbuf.9 | 3 ++- share/man/man9/mod_cc.9 | 2 +- share/man/man9/netisr.9 | 2 +- share/man/man9/pci.9 | 10 ++++++---- share/man/man9/spl.9 | 3 ++- share/man/man9/sysctl.9 | 2 +- share/man/man9/usbdi.9 | 2 +- 25 files changed, 39 insertions(+), 33 deletions(-) diff --git a/share/man/man9/BUF_ISLOCKED.9 b/share/man/man9/BUF_ISLOCKED.9 index d55f2f5d0..597038881 100644 --- a/share/man/man9/BUF_ISLOCKED.9 +++ b/share/man/man9/BUF_ISLOCKED.9 @@ -52,7 +52,7 @@ It can return: .It Dv LK_EXCLUSIVE An exclusive lock is held by curthread. .It Dv LK_EXCLOTHER -An exclusive lock is held by someone other than curthread +An exclusive lock is held by someone other than curthread. .It Dv LK_SHARED A shared lock is held. .It Li 0 diff --git a/share/man/man9/DB_COMMAND.9 b/share/man/man9/DB_COMMAND.9 index 932ffdc62..0bc6a5076 100644 --- a/share/man/man9/DB_COMMAND.9 +++ b/share/man/man9/DB_COMMAND.9 @@ -32,7 +32,7 @@ .Nm DB_COMMAND , .Nm DB_SHOW_COMMAND , .Nm DB_SHOW_ALL_COMMAND -.Nd Extends the ddb command set. +.Nd Extends the ddb command set .Sh SYNOPSIS .In ddb/ddb.h .Fo DB_COMMAND diff --git a/share/man/man9/VOP_GETEXTATTR.9 b/share/man/man9/VOP_GETEXTATTR.9 index e3abcb927..998ed2c46 100644 --- a/share/man/man9/VOP_GETEXTATTR.9 +++ b/share/man/man9/VOP_GETEXTATTR.9 @@ -71,7 +71,7 @@ will be .Dv NULL when .Fa size -is not, and vise versa. +is not, and vice versa. .It Fa cred The user credentials to use in authorizing the request. .It Fa td @@ -113,7 +113,7 @@ The uio structure refers to an invalid userspace address. .It Bq Er EINVAL The .Fa name , -.Fa namespace, +.Fa namespace , or .Fa uio argument is invalid. diff --git a/share/man/man9/VOP_GETPAGES.9 b/share/man/man9/VOP_GETPAGES.9 index e49086204..b165162f3 100644 --- a/share/man/man9/VOP_GETPAGES.9 +++ b/share/man/man9/VOP_GETPAGES.9 @@ -115,7 +115,7 @@ The page could not be written because of an error on the underlying storage medium or protocol. .It Dv VM_PAGER_FAIL Treated identically to -.Dv VM_PAGER_ERROR +.Dv VM_PAGER_ERROR . .It Dv VM_PAGER_AGAIN The page was not handled by this request. .El diff --git a/share/man/man9/VOP_GETVOBJECT.9 b/share/man/man9/VOP_GETVOBJECT.9 index 2490da710..47741d122 100644 --- a/share/man/man9/VOP_GETVOBJECT.9 +++ b/share/man/man9/VOP_GETVOBJECT.9 @@ -53,7 +53,7 @@ The vnode of the file. The VM object being returned, or .Dv NULL if the caller wants to test for the existence -of the VM object). +of the VM object. .El .Pp .Xr VFS 9 diff --git a/share/man/man9/VOP_SETEXTATTR.9 b/share/man/man9/VOP_SETEXTATTR.9 index 29f8cc276..edae937b5 100644 --- a/share/man/man9/VOP_SETEXTATTR.9 +++ b/share/man/man9/VOP_SETEXTATTR.9 @@ -96,7 +96,7 @@ The caller does not have the appropriate privilege. The request was not valid in this file system for the specified vnode and attribute name. .It Bq Er ENOMEM -Insufficient memory available to fulfill request +Insufficient memory available to fulfill the request. .It Bq Er EFAULT The uio structure refers to an invalid userspace address. .It Bq Er EINVAL diff --git a/share/man/man9/acl.9 b/share/man/man9/acl.9 index 21640bd7b..c6c715918 100644 --- a/share/man/man9/acl.9 +++ b/share/man/man9/acl.9 @@ -210,7 +210,7 @@ The following values are valid: .Xr vaccess_acl_nfs4 9 , .Xr vaccess_acl_posix1e 9 , .Xr VFS 9 , -.Xr vnaccess 9 , +.Xr vaccess 9 , .Xr VOP_ACLCHECK 9 , .Xr VOP_GETACL 9 , .Xr VOP_SETACL 9 diff --git a/share/man/man9/bus_generic_print_child.9 b/share/man/man9/bus_generic_print_child.9 index 80a04ff3d..388c0a0fb 100644 --- a/share/man/man9/bus_generic_print_child.9 +++ b/share/man/man9/bus_generic_print_child.9 @@ -51,7 +51,7 @@ foo0: on bar0 bus_generic_print_child itself calls two functions .Fn bus_print_child_header and -.Fn bus_print_child_footer +.Fn bus_print_child_footer . The former prints "foo0: " and the latter "on bar0". These routines should be used if possible in your own code if .Fn bus_generic_print_child diff --git a/share/man/man9/bus_release_resource.9 b/share/man/man9/bus_release_resource.9 index 68187ccc7..35e70d994 100644 --- a/share/man/man9/bus_release_resource.9 +++ b/share/man/man9/bus_release_resource.9 @@ -71,7 +71,7 @@ value must be the same as the one returned by .It .Fa r is the pointer to -.Va struct res , +.Va struct resource , i.e., the resource itself, returned by .Xr bus_alloc_resource 9 . diff --git a/share/man/man9/bus_space.9 b/share/man/man9/bus_space.9 index c62fde40c..e12f56f81 100644 --- a/share/man/man9/bus_space.9 +++ b/share/man/man9/bus_space.9 @@ -1380,7 +1380,8 @@ functions may be executed in any order. They may also be executed out of order with respect to other pending read and write operations unless order is enforced by use of the -.Fn bus_space_barrier function . +.Fn bus_space_barrier +function. There is no way to insert barriers between reads or writes of individual bus space locations executed by the .Fn bus_space_copy_region_N diff --git a/share/man/man9/byteorder.9 b/share/man/man9/byteorder.9 index f47f60975..9c10fbf7f 100644 --- a/share/man/man9/byteorder.9 +++ b/share/man/man9/byteorder.9 @@ -158,7 +158,7 @@ in big/little endian format. The .Fn hto* and -.Fn toh* +.Fn *toh functions first appeared in .Fx 5.0 , and were originally developed by the diff --git a/share/man/man9/devclass_get_maxunit.9 b/share/man/man9/devclass_get_maxunit.9 index fc2bc25b8..1083808e2 100644 --- a/share/man/man9/devclass_get_maxunit.9 +++ b/share/man/man9/devclass_get_maxunit.9 @@ -49,7 +49,7 @@ The function returns -1 if .Fa dc is -.Dv NULL; +.Dv NULL , otherwise it returns the next unit number in .Fa dc's diff --git a/share/man/man9/device_find_child.9 b/share/man/man9/device_find_child.9 index a23b2b2a1..391f44b7b 100644 --- a/share/man/man9/device_find_child.9 +++ b/share/man/man9/device_find_child.9 @@ -41,7 +41,7 @@ .Fn device_find_child "device_t dev" "const char *classname" "int unit" .Sh DESCRIPTION This function looks for a specific child of -.Dv dev . +.Dv dev with the given .Fa classname and diff --git a/share/man/man9/firmware.9 b/share/man/man9/firmware.9 index 5254f2448..9cb7fa33c 100644 --- a/share/man/man9/firmware.9 +++ b/share/man/man9/firmware.9 @@ -101,11 +101,13 @@ they want as an argument. If a matching image is not already registered, the firmware subsystem will try to load it using the mechanisms specified below (typically, a kernel module with -.Nm the same name +.Nm +the same name as the image). .Sh API DESCRIPTION The kernel -.Nm firmware API +.Nm +firmware API is made of the following functions: .Pp .Fn firmware_register @@ -225,7 +227,7 @@ in the module, the imagename and version of each firmware image. If you need to embed firmware images into a system, you should write appropriate entries in the file, e.g. this example is from -.Nm sys/arm/xscale/ixp425/files.ixp425: +.Nm sys/arm/xscale/ixp425/files.ixp425 : .Bd -literal ixp425_npe_fw.c optional npe_fw \\ compile-with "${AWK} -f $S/tools/fw_stub.awk \\ diff --git a/share/man/man9/hashinit.9 b/share/man/man9/hashinit.9 index d186dcfe1..b72cd7551 100644 --- a/share/man/man9/hashinit.9 +++ b/share/man/man9/hashinit.9 @@ -29,7 +29,7 @@ .Dt HASHINIT 9 .Os .Sh NAME -.Nm hashinit , hashinit_flags, hashdestroy , phashinit +.Nm hashinit , hashinit_flags , hashdestroy , phashinit .Nd manage kernel hash tables .Sh SYNOPSIS .In sys/malloc.h diff --git a/share/man/man9/ieee80211_proto.9 b/share/man/man9/ieee80211_proto.9 index 1938d6ec1..1ac94d1e0 100644 --- a/share/man/man9/ieee80211_proto.9 +++ b/share/man/man9/ieee80211_proto.9 @@ -238,4 +238,4 @@ work will be initiated outside the driver. The state machine concept was part of the original .Nm ieee80211 code base that first appeared in -.Nx 1.5 , +.Nx 1.5 . diff --git a/share/man/man9/lock.9 b/share/man/man9/lock.9 index c94612aad..5134894d9 100644 --- a/share/man/man9/lock.9 +++ b/share/man/man9/lock.9 @@ -230,7 +230,7 @@ and The .Fn lockmgr_disown function switches the owner from the current thread to be -.Dv LK_KERNPROC, +.Dv LK_KERNPROC , if the lock is already held. .Pp The diff --git a/share/man/man9/locking.9 b/share/man/man9/locking.9 index 1b723ffc2..038e908da 100644 --- a/share/man/man9/locking.9 +++ b/share/man/man9/locking.9 @@ -318,8 +318,7 @@ and reacquire it on wakeup (e.g. .Fn mtx_sleep , .Fn rw_sleep and -.Fn msleep_spin -). +.Fn msleep_spin ) . .Pp .Em *4 Though one can sleep holding an sx lock, one can also use @@ -355,6 +354,6 @@ These functions appeared in .Bsx 4.1 through -.Fx 7.0 +.Fx 7.0 . .Sh BUGS There are too many locking primitives to choose from. diff --git a/share/man/man9/mbuf.9 b/share/man/man9/mbuf.9 index bb6cb8acd..a51291345 100644 --- a/share/man/man9/mbuf.9 +++ b/share/man/man9/mbuf.9 @@ -670,7 +670,8 @@ are contiguous and lay in the data area of .Fa mbuf , so they are accessible with .Fn mtod mbuf type . -.Fa len must be smaller than, or equal to, the size of an +.Fa len +must be smaller than, or equal to, the size of an .Vt mbuf cluster . Return a pointer to an intermediate .Vt mbuf diff --git a/share/man/man9/mod_cc.9 b/share/man/man9/mod_cc.9 index 75e2db039..d753a3c12 100644 --- a/share/man/man9/mod_cc.9 +++ b/share/man/man9/mod_cc.9 @@ -287,7 +287,7 @@ The CCF_CWND_LIMITED flag is relevant in .Va ack_received and is set when the connection's ability to send data is currently constrained by the value of the congestion window. -Algorithms should use the abscence of this flag being set to avoid accumulating +Algorithms should use the absence of this flag being set to avoid accumulating a large difference between the congestion window and send window. .Sh SEE ALSO .Xr cc_chd 4 , diff --git a/share/man/man9/netisr.9 b/share/man/man9/netisr.9 index 37fd367cb..7040e8004 100644 --- a/share/man/man9/netisr.9 +++ b/share/man/man9/netisr.9 @@ -78,7 +78,7 @@ and may also manage queue limits and statistics using the .Fn netisr_getqdrops , .Fn netisr_getqlimit , and -.Fn netisr_setqlimit. +.Fn netisr_setqlimit . .Pp .Nm supports multi-processor execution of handlers, and relies on a combination diff --git a/share/man/man9/pci.9 b/share/man/man9/pci.9 index 62fd7b44d..1e2686a33 100644 --- a/share/man/man9/pci.9 +++ b/share/man/man9/pci.9 @@ -439,7 +439,7 @@ The .Fn pci_count_msi function returns the maximum number of MSI messages supported by the device -.Fa dev. +.Fa dev . If the device does not support MSI, then .Fn pci_count_msi @@ -518,7 +518,8 @@ is set to the number of messages allocated and returns zero. For MSI-X messages, the resource ID for each -.Dv SYS_RES_IRQ resource identifies the index in the MSI-X table of the +.Dv SYS_RES_IRQ +resource identifies the index in the MSI-X table of the corresponding message. A resource ID of one maps to the first index of the MSI-X table; a resource ID two identifies the second index in the table, etc. @@ -559,7 +560,7 @@ A driver may use a different distribution of available messages to table entries via the .Fn pci_remap_msix function. -Note that this function must be called after a succesful call to +Note that this function must be called after a successful call to .Fn pci_alloc_msix but before any of the .Dv SYS_RES_IRQ @@ -600,7 +601,8 @@ above for .Fn pci_alloc_msix . MSI-X table entries that with a vector of zero will not have an associated -.Dv SYS_RES_IRQ resource. +.Dv SYS_RES_IRQ +resource. Additionally, if any of the original messages allocated by .Fn pci_alloc_msix diff --git a/share/man/man9/spl.9 b/share/man/man9/spl.9 index 95a5fc25a..14a5e981a 100644 --- a/share/man/man9/spl.9 +++ b/share/man/man9/spl.9 @@ -221,7 +221,8 @@ the system. The historical number scheme can be considered as a simple linearly ordered set of interrupt priority groups. .Pp -.Fx 5.0 eliminated spl entirely in favor of locking primitives which scale +.Fx 5.0 +eliminated spl entirely in favor of locking primitives which scale to more than one processor. .Sh AUTHORS This manual page was written by diff --git a/share/man/man9/sysctl.9 b/share/man/man9/sysctl.9 index ade9f27f2..f299a6988 100644 --- a/share/man/man9/sysctl.9 +++ b/share/man/man9/sysctl.9 @@ -113,7 +113,7 @@ This is a 64-bit signed integer. This is an opaque data structure. .It Dv CTLTYPE_STRUCT Alias for -.Dv CTLTYPE_OPAQUE. +.Dv CTLTYPE_OPAQUE . .It Dv CTLTYPE_UINT This is an unsigned integer. .It Dv CTLTYPE_LONG diff --git a/share/man/man9/usbdi.9 b/share/man/man9/usbdi.9 index 9920e73c1..6f1c74f88 100644 --- a/share/man/man9/usbdi.9 +++ b/share/man/man9/usbdi.9 @@ -525,7 +525,7 @@ executed on the USB control endpoint. . This flag can be changed during operation. .Pp -"BOF" is short for "Block On Failure" +"BOF" is short for "Block On Failure". .Pp NOTE: This flag should be set on all BULK and INTERRUPT USB transfers which use an endpoint that can be shared between userland and kernel. -- 2.45.0