Date: Sun, 20 May 2012 16:43:48 +0000 (UTC) From: Glen Barber <gjb@FreeBSD.org> To: src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org Subject: svn commit: r235693 - head/share/man/man9 Message-ID: <201205201643.q4KGhmif004016@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: gjb (doc committer) Date: Sun May 20 16:43:47 2012 New Revision: 235693 URL: http://svn.freebsd.org/changeset/base/235693 Log: Typo and mdoc(7) style fixes. PR: 168117 Submitted by: Nobuyuki Koganemaru (kogane&jp!freebsd!org) MFC after: 3 days Modified: head/share/man/man9/BUF_ISLOCKED.9 head/share/man/man9/DB_COMMAND.9 head/share/man/man9/VOP_GETEXTATTR.9 head/share/man/man9/VOP_GETPAGES.9 head/share/man/man9/VOP_GETVOBJECT.9 head/share/man/man9/VOP_SETEXTATTR.9 head/share/man/man9/acl.9 head/share/man/man9/bus_generic_print_child.9 head/share/man/man9/bus_release_resource.9 head/share/man/man9/bus_space.9 head/share/man/man9/byteorder.9 head/share/man/man9/devclass_get_maxunit.9 head/share/man/man9/device_find_child.9 head/share/man/man9/firmware.9 head/share/man/man9/hashinit.9 head/share/man/man9/ieee80211_proto.9 head/share/man/man9/ifnet.9 head/share/man/man9/kqueue.9 head/share/man/man9/lock.9 head/share/man/man9/locking.9 head/share/man/man9/mbuf.9 head/share/man/man9/mod_cc.9 head/share/man/man9/netisr.9 head/share/man/man9/pci.9 head/share/man/man9/spl.9 head/share/man/man9/sysctl.9 head/share/man/man9/taskqueue.9 head/share/man/man9/usbdi.9 head/share/man/man9/vm_page_aflag.9 Modified: head/share/man/man9/BUF_ISLOCKED.9 ============================================================================== --- head/share/man/man9/BUF_ISLOCKED.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/BUF_ISLOCKED.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 Modified: head/share/man/man9/DB_COMMAND.9 ============================================================================== --- head/share/man/man9/DB_COMMAND.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/DB_COMMAND.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 Modified: head/share/man/man9/VOP_GETEXTATTR.9 ============================================================================== --- head/share/man/man9/VOP_GETEXTATTR.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/VOP_GETEXTATTR.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 u .It Bq Er EINVAL The .Fa name , -.Fa namespace, +.Fa namespace , or .Fa uio argument is invalid. Modified: head/share/man/man9/VOP_GETPAGES.9 ============================================================================== --- head/share/man/man9/VOP_GETPAGES.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/VOP_GETPAGES.9 Sun May 20 16:43:47 2012 (r235693) @@ -115,7 +115,7 @@ The page could not be written because of 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 Modified: head/share/man/man9/VOP_GETVOBJECT.9 ============================================================================== --- head/share/man/man9/VOP_GETVOBJECT.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/VOP_GETVOBJECT.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 Modified: head/share/man/man9/VOP_SETEXTATTR.9 ============================================================================== --- head/share/man/man9/VOP_SETEXTATTR.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/VOP_SETEXTATTR.9 Sun May 20 16:43:47 2012 (r235693) @@ -96,7 +96,7 @@ The caller does not have the appropriate 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 Modified: head/share/man/man9/acl.9 ============================================================================== --- head/share/man/man9/acl.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/acl.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 Modified: head/share/man/man9/bus_generic_print_child.9 ============================================================================== --- head/share/man/man9/bus_generic_print_child.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/bus_generic_print_child.9 Sun May 20 16:43:47 2012 (r235693) @@ -51,7 +51,7 @@ foo0: <FooCard 1234> 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: <FooCard 1234>" and the latter "on bar0". These routines should be used if possible in your own code if .Fn bus_generic_print_child Modified: head/share/man/man9/bus_release_resource.9 ============================================================================== --- head/share/man/man9/bus_release_resource.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/bus_release_resource.9 Sun May 20 16:43:47 2012 (r235693) @@ -71,7 +71,7 @@ value must be the same as the one return .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 . Modified: head/share/man/man9/bus_space.9 ============================================================================== --- head/share/man/man9/bus_space.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/bus_space.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 Modified: head/share/man/man9/byteorder.9 ============================================================================== --- head/share/man/man9/byteorder.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/byteorder.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 Modified: head/share/man/man9/devclass_get_maxunit.9 ============================================================================== --- head/share/man/man9/devclass_get_maxunit.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/devclass_get_maxunit.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 Modified: head/share/man/man9/device_find_child.9 ============================================================================== --- head/share/man/man9/device_find_child.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/device_find_child.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 Modified: head/share/man/man9/firmware.9 ============================================================================== --- head/share/man/man9/firmware.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/firmware.9 Sun May 20 16:43:47 2012 (r235693) @@ -101,11 +101,13 @@ they want as an argument. If a matching 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 If you need to embed firmware images into a system, you should write appropriate entries in the <files.arch> 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 \\ Modified: head/share/man/man9/hashinit.9 ============================================================================== --- head/share/man/man9/hashinit.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/hashinit.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 Modified: head/share/man/man9/ieee80211_proto.9 ============================================================================== --- head/share/man/man9/ieee80211_proto.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/ieee80211_proto.9 Sun May 20 16:43:47 2012 (r235693) @@ -238,4 +238,4 @@ work will be initiated outside the drive The state machine concept was part of the original .Nm ieee80211 code base that first appeared in -.Nx 1.5 , +.Nx 1.5 . Modified: head/share/man/man9/ifnet.9 ============================================================================== --- head/share/man/man9/ifnet.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/ifnet.9 Sun May 20 16:43:47 2012 (r235693) @@ -637,7 +637,7 @@ interfaces registered at the interface l .Aq D This interface blocks transmission of packets and discards incoming packets after BPF processing. -Used to monitor network trafic but not interact +Used to monitor network traffic but not interact with the network in question. .It Dv IFF_STATICARP .Aq D Modified: head/share/man/man9/kqueue.9 ============================================================================== --- head/share/man/man9/kqueue.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/kqueue.9 Sun May 20 16:43:47 2012 (r235693) @@ -260,8 +260,7 @@ is not required, but is commonly used. If used, the .Vt knlist must be initialized with either -.Fn knlist_init -, +.Fn knlist_init , .Fn knlist_init_mtx or .Fn knlist_init_rw_reader . Modified: head/share/man/man9/lock.9 ============================================================================== --- head/share/man/man9/lock.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/lock.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 Modified: head/share/man/man9/locking.9 ============================================================================== --- head/share/man/man9/locking.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/locking.9 Sun May 20 16:43:47 2012 (r235693) @@ -315,8 +315,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 @@ -358,6 +357,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. Modified: head/share/man/man9/mbuf.9 ============================================================================== --- head/share/man/man9/mbuf.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/mbuf.9 Sun May 20 16:43:47 2012 (r235693) @@ -403,7 +403,8 @@ for details. Associate externally managed data with .Fa mbuf . Any internal data contained in the mbuf will be discarded, and the -.Dv M_EXT flag will be set. +.Dv M_EXT +flag will be set. The .Fa buf and @@ -722,7 +723,8 @@ are contiguous and lay in the data area .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 Modified: head/share/man/man9/mod_cc.9 ============================================================================== --- head/share/man/man9/mod_cc.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/mod_cc.9 Sun May 20 16:43:47 2012 (r235693) @@ -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 , Modified: head/share/man/man9/netisr.9 ============================================================================== --- head/share/man/man9/netisr.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/netisr.9 Sun May 20 16:43:47 2012 (r235693) @@ -78,7 +78,7 @@ and may also manage queue limits and sta .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 Modified: head/share/man/man9/pci.9 ============================================================================== --- head/share/man/man9/pci.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/pci.9 Sun May 20 16:43:47 2012 (r235693) @@ -488,7 +488,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 @@ -567,7 +567,8 @@ is set to the number of messages allocat 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. @@ -608,7 +609,7 @@ A driver may use a different distributio 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 @@ -649,7 +650,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 Modified: head/share/man/man9/spl.9 ============================================================================== --- head/share/man/man9/spl.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/spl.9 Sun May 20 16:43:47 2012 (r235693) @@ -220,7 +220,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 Modified: head/share/man/man9/sysctl.9 ============================================================================== --- head/share/man/man9/sysctl.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/sysctl.9 Sun May 20 16:43:47 2012 (r235693) @@ -107,7 +107,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 Modified: head/share/man/man9/taskqueue.9 ============================================================================== --- head/share/man/man9/taskqueue.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/taskqueue.9 Sun May 20 16:43:47 2012 (r235693) @@ -189,8 +189,8 @@ The count is cleared, and the old value returned in the reference parameter .Fa pendp , -if it is non- -.Dv NULL . +if it is +.Pf non- Dv NULL . If the task is currently running, .Dv EBUSY is returned, otherwise 0. Modified: head/share/man/man9/usbdi.9 ============================================================================== --- head/share/man/man9/usbdi.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/usbdi.9 Sun May 20 16:43:47 2012 (r235693) @@ -524,7 +524,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. Modified: head/share/man/man9/vm_page_aflag.9 ============================================================================== --- head/share/man/man9/vm_page_aflag.9 Sun May 20 16:36:54 2012 (r235692) +++ head/share/man/man9/vm_page_aflag.9 Sun May 20 16:43:47 2012 (r235693) @@ -27,7 +27,7 @@ .\" $FreeBSD$ .\" .Dd August 31, 2011 -.Dt VM_PAGE_FLAG 9 +.Dt VM_PAGE_AFLAG 9 .Os .Sh NAME .Nm vm_page_aflag_clear , vm_page_aflag_set , vm_page_reference
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201205201643.q4KGhmif004016>