From 7a3e657c56eb965857c0eaa67dfd6280cc69f93b Mon Sep 17 00:00:00 2001 From: ru Date: Fri, 21 Jan 2005 08:36:40 +0000 Subject: Sort sections. --- share/man/man9/BUS_ADD_CHILD.9 | 8 ++++---- share/man/man9/BUS_PRINT_CHILD.9 | 4 ++-- share/man/man9/bus_generic_print_child.9 | 4 ++-- share/man/man9/contigmalloc.9 | 4 ++-- share/man/man9/g_access.9 | 24 ++++++++++++------------ share/man/man9/g_attach.9 | 12 ++++++------ share/man/man9/g_event.9 | 30 +++++++++++++++--------------- share/man/man9/hashinit.9 | 14 +++++++------- share/man/man9/mac.9 | 10 +++++----- share/man/man9/malloc.9 | 32 ++++++++++++++++---------------- share/man/man9/microseq.9 | 8 ++++---- share/man/man9/pfil.9 | 6 +++--- share/man/man9/pmap_page_exists_quick.9 | 10 +++++----- share/man/man9/rtentry.9 | 6 +++--- share/man/man9/uio.9 | 18 +++++++++--------- share/man/man9/vm_map_clean.9 | 8 ++++---- 16 files changed, 99 insertions(+), 99 deletions(-) (limited to 'share/man/man9') diff --git a/share/man/man9/BUS_ADD_CHILD.9 b/share/man/man9/BUS_ADD_CHILD.9 index 8a76d33..8b69d5a 100644 --- a/share/man/man9/BUS_ADD_CHILD.9 +++ b/share/man/man9/BUS_ADD_CHILD.9 @@ -58,10 +58,6 @@ Busses implementing should insert the device into the tree using .Xr device_add_child 9 before adding things such as their own ivars and resource lists to the device. -.Sh SEE ALSO -.Xr device 9 , -.Xr device_add_child 9 , -.Xr driver 9 .Sh RETURN VALUES The .Fn BUS_ADD_CHILD @@ -69,6 +65,10 @@ method returns .Vt device_t added to the tree, or .Dv NULL . +.Sh SEE ALSO +.Xr device 9 , +.Xr device_add_child 9 , +.Xr driver 9 .Sh AUTHORS This manual page was written by .An M. Warner Losh . diff --git a/share/man/man9/BUS_PRINT_CHILD.9 b/share/man/man9/BUS_PRINT_CHILD.9 index 9601466..a3709d9 100644 --- a/share/man/man9/BUS_PRINT_CHILD.9 +++ b/share/man/man9/BUS_PRINT_CHILD.9 @@ -54,11 +54,11 @@ Please see for more information regarding the proper formatting of the messages printed by .Fn BUS_PRINT_CHILD . +.Sh RETURN VALUES +The number of characters output. .Sh SEE ALSO .Xr device 9 , .Xr driver 9 -.Sh RETURN VALUES -The number of characters output. .Sh AUTHORS This manual page was written by .An Doug Rabson . diff --git a/share/man/man9/bus_generic_print_child.9 b/share/man/man9/bus_generic_print_child.9 index ae7780d..b4f1b87 100644 --- a/share/man/man9/bus_generic_print_child.9 +++ b/share/man/man9/bus_generic_print_child.9 @@ -56,10 +56,10 @@ 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 does not completely suit your needs. -.Sh SEE ALSO -.Xr device 9 .Sh RETURN VALUES The number of characters output. +.Sh SEE ALSO +.Xr device 9 .Sh AUTHORS This man page was written by .An Doug Rabson . diff --git a/share/man/man9/contigmalloc.9 b/share/man/man9/contigmalloc.9 index 885357b..69c9ee5 100644 --- a/share/man/man9/contigmalloc.9 +++ b/share/man/man9/contigmalloc.9 @@ -109,8 +109,6 @@ p = contigmalloc(8192, M_DEVBUF, M_ZERO, 0, (1L << 22), Ask for 8192 bytes of zero-filled memory residing between physical address 0 and 4194303 inclusive, aligned to a 32K boundary and not crossing a 1M address boundary. -.Sh SEE ALSO -.Xr malloc 9 .Sh DIAGNOSTICS The .Fn contigmalloc @@ -121,3 +119,5 @@ is zero, or if or .Fa boundary is not a power of two. +.Sh SEE ALSO +.Xr malloc 9 diff --git a/share/man/man9/g_access.9 b/share/man/man9/g_access.9 index 5bb8d52..95ad1da 100644 --- a/share/man/man9/g_access.9 +++ b/share/man/man9/g_access.9 @@ -86,18 +86,6 @@ cannot fail when the arguments and .Fa dce are less than or equal to 0. -.Sh ERRORS -Possible errors: -.Bl -tag -width Er -.It Bq Er EPERM -The function is trying to open a provider with an exclusive access count, but -it is already open for writing. -.It Bq Er EPERM -The function is trying to open a provider for writing, but it is already -exclusively open. -.El -.Pp -Any other error that can be returned by the provider's access method. .Sh EXAMPLES Create a consumer, attach it to a given provider, gain read access and read first sector. @@ -147,6 +135,18 @@ some_function(struct g_geom *mygeom, struct g_provider *pp) g_destroy_consumer(cp); } .Ed +.Sh ERRORS +Possible errors: +.Bl -tag -width Er +.It Bq Er EPERM +The function is trying to open a provider with an exclusive access count, but +it is already open for writing. +.It Bq Er EPERM +The function is trying to open a provider for writing, but it is already +exclusively open. +.El +.Pp +Any other error that can be returned by the provider's access method. .Sh SEE ALSO .Xr geom 4 , .Xr DECLARE_GEOM_CLASS 9 , diff --git a/share/man/man9/g_attach.9 b/share/man/man9/g_attach.9 index 96ba0eb..4bf7d9c 100644 --- a/share/man/man9/g_attach.9 +++ b/share/man/man9/g_attach.9 @@ -79,12 +79,6 @@ The topology lock has to be held. The .Fn g_attach function returns 0 if successful; otherwise an error code is returned. -.Sh ERRORS -Possible errors: -.Bl -tag -width Er -.It Bq Er ELOOP -The operation creates a topology loop. -.El .Sh EXAMPLES Create a consumer, attach it to a given provider, gain read access and clean up. .Bd -literal -offset indent @@ -123,6 +117,12 @@ some_function(struct g_geom *mygeom, struct g_provider *pp) g_destroy_consumer(cp); } .Ed +.Sh ERRORS +Possible errors: +.Bl -tag -width Er +.It Bq Er ELOOP +The operation creates a topology loop. +.El .Sh SEE ALSO .Xr geom 4 , .Xr DECLARE_GEOM_CLASS 9 , diff --git a/share/man/man9/g_event.9 b/share/man/man9/g_event.9 index 0cb574d..380caa8 100644 --- a/share/man/man9/g_event.9 +++ b/share/man/man9/g_event.9 @@ -130,6 +130,21 @@ and .Fn g_waitfor_event functions return 0 if successful; otherwise an error code is returned. +.Sh EXAMPLES +Example of a function called from the event queue. +.Bd -literal -offset indent +void +example_event(void *arg, int flag) +{ + + if (flag == EV_CANCEL) { + printf("Event with argument %p canceled.\\n", arg); + return; + } + + printf("Event with argument %p called.\\n", arg); +} +.Ed .Sh ERRORS Possible errors for the .Fn g_post_event @@ -156,21 +171,6 @@ argument was set to .Dv M_NOWAIT and there was insufficient memory. .El -.Sh EXAMPLES -Example of a function called from the event queue. -.Bd -literal -offset indent -void -example_event(void *arg, int flag) -{ - - if (flag == EV_CANCEL) { - printf("Event with argument %p canceled.\\n", arg); - return; - } - - printf("Event with argument %p called.\\n", arg); -} -.Ed .Sh SEE ALSO .Xr geom 4 , .Xr DECLARE_GEOM_CLASS 9 , diff --git a/share/man/man9/hashinit.9 b/share/man/man9/hashinit.9 index 3d2c996..15fdb3b 100644 --- a/share/man/man9/hashinit.9 +++ b/share/man/man9/hashinit.9 @@ -80,6 +80,10 @@ The argument should be the bit mask returned by the call to .Fn hashinit that allocated the hash table. +.Sh IMPLEMENTATION NOTES +The largest prime hash value chosen by +.Fn phashinit +is 32749. .Sh RETURN VALUES The .Fn hashinit @@ -95,10 +99,6 @@ function returns a pointer to an allocated hash table and sets the location pointed to by .Fa nentries to the number of rows in the hash table. -.Sh IMPLEMENTATION NOTES -The largest prime hash value chosen by -.Fn phashinit -is 32749. .Sh EXAMPLES A typical example is shown below: .Bd -literal -offset indent @@ -122,9 +122,6 @@ uses the value in \&... hashdestroy(footable, M_FOO, foomask); .Ed -.Sh SEE ALSO -.Xr LIST_HEAD 3 , -.Xr malloc 9 .Sh DIAGNOSTICS The .Fn hashinit @@ -140,6 +137,9 @@ function will panic if the hash table pointed to by .Fa hashtbl is not empty. +.Sh SEE ALSO +.Xr LIST_HEAD 3 , +.Xr malloc 9 .Sh BUGS There is no .Fn phashdestroy diff --git a/share/man/man9/mac.9 b/share/man/man9/mac.9 index 5218fa9..7511bd8 100644 --- a/share/man/man9/mac.9 +++ b/share/man/man9/mac.9 @@ -176,6 +176,11 @@ for information on the MAC Framework APIs. .%T "The FreeBSD Developers' Handbook" .%O "http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/" .Re +.Sh HISTORY +The +.Tn TrustedBSD +MAC Framework first appeared in +.Fx 5.0 . .Sh AUTHORS This man page was written by .An Robert Watson . @@ -227,11 +232,6 @@ Additional contributors include: .An Andrew Reiter , and .An Tim Robbins . -.Sh HISTORY -The -.Tn TrustedBSD -MAC Framework first appeared in -.Fx 5.0 . .Sh BUGS See the earlier section in this document concerning appropriateness for production use. diff --git a/share/man/man9/malloc.9 b/share/man/man9/malloc.9 index 442e41e..ea4dd06 100644 --- a/share/man/man9/malloc.9 +++ b/share/man/man9/malloc.9 @@ -231,18 +231,6 @@ one must include .In sys/types.h ) and .In sys/kernel.h . -.Sh RETURN VALUES -The -.Fn malloc , -.Fn realloc , -and -.Fn reallocf -functions return a kernel virtual address that is suitably aligned for -storage of any type of object, or -.Dv NULL -if the request could not be satisfied (implying that -.Dv M_NOWAIT -was set). .Sh IMPLEMENTATION NOTES The memory allocator allocates memory in chunks that have size a power of two for requests up to the size of a page of memory. @@ -290,10 +278,18 @@ when holding a .Xr vnode 9 interlock, will cause a LOR (Lock Order Reversal) due to the intertwining of VM Objects and Vnodes. -.Sh SEE ALSO -.Xr vmstat 8 , -.Xr contigmalloc 9 , -.Xr vnode 9 +.Sh RETURN VALUES +The +.Fn malloc , +.Fn realloc , +and +.Fn reallocf +functions return a kernel virtual address that is suitably aligned for +storage of any type of object, or +.Dv NULL +if the request could not be satisfied (implying that +.Dv M_NOWAIT +was set). .Sh DIAGNOSTICS A kernel compiled with the .Dv INVARIANTS @@ -305,3 +301,7 @@ and functions. Failing consistency checks will cause a panic or a system console message. +.Sh SEE ALSO +.Xr vmstat 8 , +.Xr contigmalloc 9 , +.Xr vnode 9 diff --git a/share/man/man9/microseq.9 b/share/man/man9/microseq.9 index c4197d9..041e2be 100644 --- a/share/man/man9/microseq.9 +++ b/share/man/man9/microseq.9 @@ -474,10 +474,6 @@ at ppc level to avoid ppbus to adapter function call overhead. But some actions like deciding whereas the transfer is IEEE1284-1994 compliant are executed at ppbus layer. -.Sh BUGS -Only one level of submicrosequences is allowed. -.Pp -When triggering the port, maximum delay allowed is 255 us. .Sh SEE ALSO .Xr ppbus 4 , .Xr ppc 4 , @@ -491,3 +487,7 @@ manual page first appeared in This manual page was written by .An Nicolas Souchu . +.Sh BUGS +Only one level of submicrosequences is allowed. +.Pp +When triggering the port, maximum delay allowed is 255 us. diff --git a/share/man/man9/pfil.9 b/share/man/man9/pfil.9 index cf10e25..b54449e 100644 --- a/share/man/man9/pfil.9 +++ b/share/man/man9/pfil.9 @@ -143,6 +143,9 @@ The .Fn pfil_head_unregister function might sleep! +.Sh SEE ALSO +.Xr bpf 4 , +.Xr bridge 4 .Sh HISTORY The .Nm @@ -209,6 +212,3 @@ of time. will return .Er ENOBUFS to indicate this. -.Sh SEE ALSO -.Xr bpf 4 , -.Xr bridge 4 diff --git a/share/man/man9/pmap_page_exists_quick.9 b/share/man/man9/pmap_page_exists_quick.9 index f0db837..8db2580 100644 --- a/share/man/man9/pmap_page_exists_quick.9 +++ b/share/man/man9/pmap_page_exists_quick.9 @@ -45,6 +45,11 @@ function is used to quickly determine if the page exists in the physical map .Fa pmap . It is typically called from the VM paging code. +.Sh IMPLEMENTATION NOTES +The PV count used above may be changed upwards or downwards in future; +it is only necessary that +.Dv TRUE +be returned for a small subset of pmaps for proper page aging. .Sh RETURN VALUES The .Fn pmap_page_exists_quick @@ -54,11 +59,6 @@ only if the PV entry for the physical map .Fa pmap is one of the first 16 PVs linked from the page .Fa m . -.Sh IMPLEMENTATION NOTES -The PV count used above may be changed upwards or downwards in future; -it is only necessary that -.Dv TRUE -be returned for a small subset of pmaps for proper page aging. .Sh SEE ALSO .Xr pmap 9 .Sh AUTHORS diff --git a/share/man/man9/rtentry.9 b/share/man/man9/rtentry.9 index 94b3810..6b70994 100644 --- a/share/man/man9/rtentry.9 +++ b/share/man/man9/rtentry.9 @@ -286,6 +286,9 @@ The radix-tree representation of the routing table and the .Vt rt_metrics structure first appeared in .Bx 4.3 reno . +.Sh AUTHORS +This manual page was written by +.An Garrett Wollman . .Sh BUGS There are a number of historical relics remaining in this interface. The @@ -298,6 +301,3 @@ There is some disagreement over whether it is legitimate for .Dv RTF_LLINFO to be set by any process other than .Va rt_ifa->ifa_rtrequest . -.Sh AUTHORS -This manual page was written by -.An Garrett Wollman . diff --git a/share/man/man9/uio.9 b/share/man/man9/uio.9 index 0126754..b567067 100644 --- a/share/man/man9/uio.9 +++ b/share/man/man9/uio.9 @@ -111,6 +111,15 @@ for the associated thread; used if indicates that the transfer is to be made from/to a process's address space. .El +.Sh RETURN VALUES +.Fn uiomove +can return +.Er EFAULT +from the invoked +.Xr copyin 9 +or +.Xr copyout 9 +in case the transfer was to/from a process's address space. .Sh EXAMPLES The idea is that the driver maintains a private buffer for its data, and processes the request in chunks of maximal the size of this @@ -151,15 +160,6 @@ fooread(dev_t dev, struct uio *uio, int flag) return (rv); } .Ed -.Sh RETURN VALUES -.Fn uiomove -can return -.Er EFAULT -from the invoked -.Xr copyin 9 -or -.Xr copyout 9 -in case the transfer was to/from a process's address space. .Sh SEE ALSO .Xr read 2 , .Xr readv 2 , diff --git a/share/man/man9/vm_map_clean.9 b/share/man/man9/vm_map_clean.9 index 85af33c..a739044 100644 --- a/share/man/man9/vm_map_clean.9 +++ b/share/man/man9/vm_map_clean.9 @@ -61,6 +61,10 @@ is TRUE, any cached pages are also freed. .Pp The range provided must be contiguous, it MUST NOT contain holes. The range provided MUST NOT contain any sub-map entries. +.Sh IMPLEMENTATION NOTES +This routine holds the +.Va Giant +lock to prevent multiple entry. .Sh RETURN VALUES The .Fn vm_map_clean @@ -74,10 +78,6 @@ will be returned if the function encountered a sub-map entry; .Dv KERN_INVALID_ARGUMENT will be returned if the function encountered a hole in the region provided, or if an entry could not be found for the given start address. -.Sh IMPLEMENTATION NOTES -This routine holds the -.Va Giant -lock to prevent multiple entry. .Sh SEE ALSO .Xr vm_map 9 .Sh AUTHORS -- cgit v1.1