diff options
author | ru <ru@FreeBSD.org> | 2003-02-24 22:53:26 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2003-02-24 22:53:26 +0000 |
commit | 0dea5415679a9db700f2846b28d2d8ff833032c7 (patch) | |
tree | 9409aa78bd0bf64293f9e45238d4a82861b7663b /lib | |
parent | 83d0e58172de7563f59519892b23c2fd0e80ca56 (diff) | |
download | FreeBSD-src-0dea5415679a9db700f2846b28d2d8ff833032c7.zip FreeBSD-src-0dea5415679a9db700f2846b28d2d8ff833032c7.tar.gz |
mdoc(7) police: Scheduled sweep.
Diffstat (limited to 'lib')
-rw-r--r-- | lib/libc/gen/sem_open.3 | 11 | ||||
-rw-r--r-- | lib/libc/gen/signbit.3 | 2 | ||||
-rw-r--r-- | lib/libc/posix1e/mac_prepare.3 | 25 | ||||
-rw-r--r-- | lib/libc/sys/kse.2 | 11 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_attr.3 | 4 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_attr_get_np.3 | 16 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_attr_setcreatesuspend_np.3 | 24 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_main_np.3 | 27 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_multi_np.3 | 36 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_mutexattr_getkind_np.3 | 41 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_resume_all_np.3 | 14 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_resume_np.3 | 20 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_set_name_np.3 | 14 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_suspend_all_np.3 | 15 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_suspend_np.3 | 20 | ||||
-rw-r--r-- | lib/libc_r/man/pthread_switch_add_np.3 | 36 | ||||
-rw-r--r-- | lib/libc_r/man/sem_open.3 | 11 | ||||
-rw-r--r-- | lib/libgeom/libgeom.3 | 53 |
18 files changed, 186 insertions, 194 deletions
diff --git a/lib/libc/gen/sem_open.3 b/lib/libc/gen/sem_open.3 index ff358f7..6beee26 100644 --- a/lib/libc/gen/sem_open.3 +++ b/lib/libc/gen/sem_open.3 @@ -128,9 +128,7 @@ and the global variable .Va errno is set to indicate the error. .Pp -.Rv -std sem_close -.Pp -.Rv -std sem_unlink +.Rv -std sem_close sem_unlink .Sh ERRORS The .Fn sem_open @@ -204,9 +202,9 @@ The named semaphore does not exist. .Xr umask 2 , .Xr unlink 2 , .Xr sem_getvalue 3 , -.Xr sem_wait 3 , -.Xr sem_trywait 3 , .Xr sem_post 3 , +.Xr sem_trywait 3 , +.Xr sem_wait 3 , .Xr sem 4 .Sh STANDARDS The @@ -225,4 +223,5 @@ This implementation places strict requirements on the value of it must begin with a slash .Pq Ql / , contain no other slash characters, -and be less than 14 characters in length not including the terminating null. +and be less than 14 characters in length +not including the terminating null character. diff --git a/lib/libc/gen/signbit.3 b/lib/libc/gen/signbit.3 index 9645d0a..fcc7df4 100644 --- a/lib/libc/gen/signbit.3 +++ b/lib/libc/gen/signbit.3 @@ -40,7 +40,7 @@ The .Fn signbit macro takes an argument of -.Va x +.Fa x and returns non-zero if the value of its sign is negative, otherwise 0. .Sh SEE ALSO .Xr fpclassify 3 , diff --git a/lib/libc/posix1e/mac_prepare.3 b/lib/libc/posix1e/mac_prepare.3 index 16887bd..aebaeec 100644 --- a/lib/libc/posix1e/mac_prepare.3 +++ b/lib/libc/posix1e/mac_prepare.3 @@ -1,12 +1,12 @@ .\" Copyright (c) 2002 Networks Associates Technology, Inc. .\" All rights reserved. -.\" +.\" .\" This software was developed for the FreeBSD Project by Chris .\" Costello at Safeport Network Services and Network Associates Labs, .\" the Security Research Division of Network Associates, Inc. under .\" DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the .\" DARPA CHATS research program. -.\" +.\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -15,7 +15,7 @@ .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" +.\" .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE @@ -27,16 +27,19 @@ .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. -.\" +.\" .\" $FreeBSD$ -.Dd DECEMBER 12, 2002 +.\" +.Dd December 12, 2002 .Os .Dt MAC_PREPARE 3 .Sh NAME -.Nm mac_prepare -.Nd allocate appropriate storage for mac_t +.Nm mac_prepare , mac_prepare_file_label , +.Nm mac_prepare_ifnet_label , mac_prepare_process_label +.Nd allocate appropriate storage for +.Vt mac_t .Sh SYNOPSIS -.In "sys/mac.h" +.In sys/mac.h .Ft int .Fn mac_prepare "mac_t *mac" "char *elements" .Ft int @@ -55,7 +58,7 @@ for use by .Pp The .Fn mac_prepare -function accepts a list of policy names as a parameter and allocates the +function accepts a list of policy names as a parameter, and allocates the storage to fit those label elements accordingly. .Pp The @@ -66,7 +69,7 @@ and functions allocate the storage to fit file, network interface, and process labels, respectively. .Sh RETURN VALUES -.Rv -std mac_prepare mac_prepare_file_label mac_prepare_ifnet_label mac_prepare_process_label +.Rv -std .Sh SEE ALSO .Xr mac 3 , .Xr mac_free 3 , @@ -76,7 +79,7 @@ and process labels, respectively. .Xr mac 4 , .Xr maclabel 7 .Sh STANDARDS -POSIX.1e is described in IEEE POSIX.1e draft 17. +POSIX.1e is described in IEEE POSIX.1e draft 17. Discussion of the draft continues on the cross-platform POSIX.1e implementation mailing list. To join this list, see the diff --git a/lib/libc/sys/kse.2 b/lib/libc/sys/kse.2 index 51d08e4..0cfbac1 100644 --- a/lib/libc/sys/kse.2 +++ b/lib/libc/sys/kse.2 @@ -172,7 +172,8 @@ and any KSE in a KSE group may be assigned by the kernel to any runnable (in the kernel) thread associated with that KSE group. In practice, the kernel attempts to preserve the affinity between threads and actual CPUs to optimize cache behavior, but this is invisible to the -user process. (Affinity is not yet implemented). +user process. +(Affinity is not yet implemented.) .Pp Each KSE has a unique .Sy "KSE mailbox" @@ -268,7 +269,7 @@ instead, the KSE just looses the association with its mailbox and .Fn kse_exit returns normally. This returns the process to its original, unthreaded state. -(this is not yet implemented). +(This is not yet implemented.) .Pp The .Fn kse_release @@ -324,7 +325,7 @@ When a process has at least one KSE with an associated mailbox, then signals might no longer be delivered on the process stack. Instead, signals may be delivered via upcalls. Multiple signals may be delivered with one upcall. -(This feature is not yet coded). +(This feature is not yet coded.) .Pp If there are multiple KSE groups in the process, which KSE group is chosen to deliver the signal is indeterminate. @@ -436,7 +437,8 @@ contains the list of signals caught by this process since the previous upcall to any KSE in the process. As long as there exists one or more KSEs with an associated mailbox in the user process, signals are delivered this way rather than the -traditional way. (This has not bein implemented and may change). +traditional way. +(This has not been implemented and may change.) .Pp .Va km_timeofday is set by the kernel to the current system time before performing @@ -521,7 +523,6 @@ system calls do not return if successful. .Pp All of these system calls return a non-zero error code in case of an error. -.Pp .Sh ERRORS The .Fn kse_create diff --git a/lib/libc_r/man/pthread_attr.3 b/lib/libc_r/man/pthread_attr.3 index 454cefb..3797542 100644 --- a/lib/libc_r/man/pthread_attr.3 +++ b/lib/libc_r/man/pthread_attr.3 @@ -144,9 +144,9 @@ Invalid value for .Pp The .Fn pthread_attr_setstacksize -or +and .Fn pthread_attr_setstack -function will fail if: +functions will fail if: .Bl -tag -width Er .It Bq Er EINVAL .Fa stacksize diff --git a/lib/libc_r/man/pthread_attr_get_np.3 b/lib/libc_r/man/pthread_attr_get_np.3 index 57b8e2a..bf856d4 100644 --- a/lib/libc_r/man/pthread_attr_get_np.3 +++ b/lib/libc_r/man/pthread_attr_get_np.3 @@ -44,8 +44,8 @@ Most fields of .Vt pthread_attr_t structure are exact values of attributes provided at thread creation time (as parameter to -.Fn pthread_create -function), except stack address. +.Xr pthread_create 3 +function), except for the stack address. .Pp Value returned as .Fa dst @@ -61,11 +61,11 @@ should point to allocated memory area big enough to fit this structure. It is HIGHLY RECOMMENDED to use .Xr pthread_attr_init 3 function to allocate attribute storage. -.Sh IMPLEMENTATION DETAILS +.Sh IMPLEMENTATION NOTES The .Fn pthread_attr_get_np -function will always return pointer to thread's real stack address -regardless to its value in original attributes structure. +function will always return a pointer to the thread's real stack address, +regardless of its value in the original attributes structure. .Sh EXAMPLES .Bd -literal size_t @@ -109,7 +109,7 @@ thread ID. .Xr pthread_attr_init 3 .Sh AUTHORS The -.Nm -function and manpage were written by +.Fn pthread_attr_get_np +function and this manual page were written by .An Alexey Zelkin -.Aq phantom@FreeBSD.org +.Aq phantom@FreeBSD.org . diff --git a/lib/libc_r/man/pthread_attr_setcreatesuspend_np.3 b/lib/libc_r/man/pthread_attr_setcreatesuspend_np.3 index 15b0857..7059905 100644 --- a/lib/libc_r/man/pthread_attr_setcreatesuspend_np.3 +++ b/lib/libc_r/man/pthread_attr_setcreatesuspend_np.3 @@ -40,35 +40,33 @@ The .Fn pthread_attr_setcreatesuspend_np instructs -.Fn pthread_create -that thread created with attribute +.Xr pthread_create 3 +that the thread created with the .Fa attr -should be created and left in suspended state until explicit resume call (by +attribute +should be created and left in a suspended state until explicitly resumed +by the call to .Fn pthread_resume_np or -.Fn pthread_resume_all_np -function.) +.Fn pthread_resume_all_np . .Sh RETURN VALUES .Rv -std pthread_attr_setcreatesuspend_np .Sh ERRORS The .Fn pthread_attr_setcreatesuspend_np function will fail if: -.Bl -tag -witdh Er +.Bl -tag -width Er .It Bq Er EINVAL The value specified by .Fa attr -is invalid +is invalid. .El .Sh SEE ALSO -.Xr pthread_attr_init 3 , .Xr pthread_attr_destroy 3 , +.Xr pthread_attr_init 3 , .Xr pthread_create 3 , .Xr pthread_resume_all_np 3 , .Xr pthread_resume_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/lib/libc_r/man/pthread_main_np.3 b/lib/libc_r/man/pthread_main_np.3 index 6d9d830..9065b90 100644 --- a/lib/libc_r/man/pthread_main_np.3 +++ b/lib/libc_r/man/pthread_main_np.3 @@ -35,33 +35,26 @@ .Sh SYNOPSIS .In pthread_np.h .Ft int -.Fn pthread_main_np "void" +.Fn pthread_main_np void .Sh DESCRIPTION The .Fn pthread_main_np -is used in userland threads environment to identify initial thread. -Its semantics is similar to Solaris's +function +is used in userland threads environment to identify the initial thread. +Its semantics is similar to the Solaris's .Fn thr_main function. .Sh RETURN VALUES The .Fn pthread_main_np -function returns one of the following: -.Bl -tag -.It 1 -if the calling thread is the initial thread -.It 0 -if the calling thread is not the initial thread -.It -1 -if threads initialization has not completed -.El +function returns +1 if the calling thread is the initial thread, +0 if the calling thread is not the initial thread, +and \-1 if the thread's initialization has not yet completed. .Sh SEE ALSO .Xr pthread_create 3 , .Xr pthread_equal 3 , .Xr pthread_self 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/lib/libc_r/man/pthread_multi_np.3 b/lib/libc_r/man/pthread_multi_np.3 index ba143fe..5588c6c 100644 --- a/lib/libc_r/man/pthread_multi_np.3 +++ b/lib/libc_r/man/pthread_multi_np.3 @@ -30,35 +30,37 @@ .Sh NAME .Nm pthread_multi_np , .Nm pthread_single_np -.Nd switch betwen multi- and single-threaded scheduling modes +.Nd "switch between multi- and single-threaded scheduling modes" .Sh LIBRARY .Lb libc_r .Sh SYNOPSIS .In pthread_np.h .Ft int -.Fn pthread_multi_np "void" +.Fn pthread_multi_np void .Ft int -.Fn pthread_single_np "void" +.Fn pthread_single_np void .Sh DESCRIPTION The .Fn pthread_single_np -function call switches process to single-threaded mode, i.e. -suspend all threads except current. -Semantic of this function is similar to -.Fn pthread_suspend_all_np . +function switches the process to a single-threaded mode, i.e., +suspends all threads except the current. +The semantics of this function is similar to +.Xr pthread_suspend_all_np 3 . .Pp The .Fn pthread_multi_np -function call switches process to multi-threaded mode, entered by -.Fn pthread_single_np -Semantic of this function is similar to -.Fn pthread_resume_all_np . +function switches the process to a multi-threaded mode. +The semantics of this function is similar to +.Xr pthread_resume_all_np 3 . +.Sh RETURN VALUES +The +.Fn pthread_multi_np +and +.Nm pthread_single_np +functions always return 0. .Sh SEE ALSO .Xr pthread_resume_all_np 3 , -.Xr pthread_single_all_np 3 +.Xr pthread_suspend_all_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/lib/libc_r/man/pthread_mutexattr_getkind_np.3 b/lib/libc_r/man/pthread_mutexattr_getkind_np.3 index 5cdfc26..8bb673c 100644 --- a/lib/libc_r/man/pthread_mutexattr_getkind_np.3 +++ b/lib/libc_r/man/pthread_mutexattr_getkind_np.3 @@ -30,7 +30,7 @@ .Sh NAME .Nm pthread_mutexattr_getkind_np , .Nm pthread_mutexattr_setkind_np -.Nd mutex attribute operations (LEGACY) +.Nd mutex attribute operations (legacy) .Sh LIBRARY .Lb libc_r .Sh SYNOPSIS @@ -40,45 +40,42 @@ .Ft int .Fn pthread_mutexattr_setkind_np "pthread_mutexattr_t *attr" "int kind" .Sh DESCRIPTION -These functions are DEPRECATED and NON-PORTABLE implementation of mutex types -manipulation. +.Bf -symbolic +These functions are deprecated and non-portable implementation of +the mutex type manipulation. +.Ef .Pp -It's recomended to use -.Fn pthread_mutexattr_gettype +It is recommended to use the +.Xr pthread_mutexattr_gettype 3 and -.Fn pthread_mutexattr_settype +.Xr pthread_mutexattr_settype 3 functions instead. .Sh RETURN VALUES The .Fn pthread_mutexattr_getkind_np -function returns positive value representing -.Ft kind -of mutex attribute +function returns a positive value representing the +.Dq kind +of the mutex attribute .Fa attr -if successful; otherwise the value -1 is returned and the global variable -.Fa errno +if successful; otherwise the value \-1 is returned and the global variable +.Va errno is set to indicate the error. .Pp -The -.Fn pthread_mutexattr_settype -function returns the value 0 if successful; otherwise -the value -1 is returned and the global variable -.Fa errno -is set to indicate the error. +.Rv -std pthread_mutexattr_setkind_np .Sh ERRORS The .Fn pthread_mutexattr_getkind_np and .Fn pthread_mutexattr_setkind_np functions will fail if: -.Bl -tag -witdh Er +.Bl -tag -width Er .It Bq Er EINVAL The value specified by .Fa attr -is invalid +is invalid. .El .Sh SEE ALSO -.Xr pthread_mutex_create 3 , -.Xr pthread_mutex_destroy 3 , .Xr pthread_mutexattr_gettype 3 , -.Xr pthread_mutexattr_settype 3 +.Xr pthread_mutexattr_settype 3 , +.Xr pthread_mutex_create 3 , +.Xr pthread_mutex_destroy 3 diff --git a/lib/libc_r/man/pthread_resume_all_np.3 b/lib/libc_r/man/pthread_resume_all_np.3 index a59497c..90b2657 100644 --- a/lib/libc_r/man/pthread_resume_all_np.3 +++ b/lib/libc_r/man/pthread_resume_all_np.3 @@ -35,21 +35,17 @@ .Sh SYNOPSIS .In pthread_np.h .Ft void -.Fn pthread_resume_all_np "void" +.Fn pthread_resume_all_np void .Sh DESCRIPTION The .Fn pthread_resume_all_np -function call causes all active thread to be scanned -and resume those which were suspended previously. +function causes all active threads to be scanned +and resumes those which were previously suspended. .Sh SEE ALSO .Xr pthread_attr_setcreatesuspend_np 3 , .Xr pthread_resume_np 3 , .Xr pthread_suspend_all_np 3 , .Xr pthread_suspend_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/lib/libc_r/man/pthread_resume_np.3 b/lib/libc_r/man/pthread_resume_np.3 index 355e5cf..4a1a077 100644 --- a/lib/libc_r/man/pthread_resume_np.3 +++ b/lib/libc_r/man/pthread_resume_np.3 @@ -39,8 +39,8 @@ .Sh DESCRIPTION The .Fn pthread_resume_np -function called on suspended thread cause it to resume. -If thread specified by +function, called on a suspended thread, causes it to resume. +If a thread specified by the .Fa tid argument is not suspended, no actions will be performed. .Sh RETURN VALUES @@ -52,13 +52,13 @@ Otherwise, an error number is returned to indicate the error. The .Fn pthread_resume_np function will fail if: -.Bl -tag -witdh Er +.Bl -tag -width Er .It Bq Er EINVAL -The value specified by +The value specified by the .Fa tid -is invalid +argument is invalid. .It Bq ESRC -No thread could be found corresponding to thread ID specified by +No thread could be found corresponding to the thread ID specified by the .Fa tid argument. .El @@ -68,9 +68,5 @@ argument. .Xr pthread_suspend_all_np 3 , .Xr pthread_suspend_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/lib/libc_r/man/pthread_set_name_np.3 b/lib/libc_r/man/pthread_set_name_np.3 index 1919e95..a768e4c 100644 --- a/lib/libc_r/man/pthread_set_name_np.3 +++ b/lib/libc_r/man/pthread_set_name_np.3 @@ -45,15 +45,11 @@ argument to string value specified by .Fa name argument. .Pp -This is rather debuging interface and using it at day-by-day basis makes +This is a debugging interface and using it on a day-by-day basis makes no sense. .Sh ERRORS -Because of debuging orientation of this function all errors that may -appear inside are sliently ignored. +Because of the debugging nature of this function, all errors that may +appear inside are silently ignored. .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/lib/libc_r/man/pthread_suspend_all_np.3 b/lib/libc_r/man/pthread_suspend_all_np.3 index 2a33b30..56c78f1 100644 --- a/lib/libc_r/man/pthread_suspend_all_np.3 +++ b/lib/libc_r/man/pthread_suspend_all_np.3 @@ -35,12 +35,13 @@ .Sh SYNOPSIS .In pthread_np.h .Ft void -.Fn pthread_suspend_all_np "void" +.Fn pthread_suspend_all_np void .Sh DESCRIPTION The .Fn pthread_suspend_all_np -function call causes all active thread to be suspended. -The only exception is current thread, i.e. thread which called +function causes all active threads to be suspended. +The only exception is the current thread, +the thread that called the .Fn pthread_suspend_all_np function. .Sh SEE ALSO @@ -48,9 +49,5 @@ function. .Xr pthread_resume_np 3 , .Xr pthread_suspend_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/lib/libc_r/man/pthread_suspend_np.3 b/lib/libc_r/man/pthread_suspend_np.3 index d742a86..c8a9c8f 100644 --- a/lib/libc_r/man/pthread_suspend_np.3 +++ b/lib/libc_r/man/pthread_suspend_np.3 @@ -39,7 +39,7 @@ .Sh DESCRIPTION The .Fn pthread_suspend_np -function called on active thread cause it to suspend. +function, called on an active thread, causes it to suspend. .Sh RETURN VALUES If successful, .Fn pthread_suspend_np @@ -49,15 +49,15 @@ Otherwise, an error number is returned to indicate the error. The .Fn pthread_suspend_np function will fail if: -.Bl -tag -witdh Er +.Bl -tag -width Er .It Bq Er EDEADLK -Attempt to suspend current thread +An attempt was made to suspend the current thread. .It Bq Er EINVAL -The value specified by +The value specified by the .Fa tid -is invalid +argument is invalid. .It Bq ESRC -No thread could be found corresponding to thread ID specified by +No thread could be found corresponding to the thread ID specified by the .Fa tid argument. .El @@ -66,9 +66,5 @@ argument. .Xr pthread_resume_np 3 , .Xr pthread_suspend_all_np 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/lib/libc_r/man/pthread_switch_add_np.3 b/lib/libc_r/man/pthread_switch_add_np.3 index 07476cf..9e7618c 100644 --- a/lib/libc_r/man/pthread_switch_add_np.3 +++ b/lib/libc_r/man/pthread_switch_add_np.3 @@ -30,7 +30,7 @@ .Sh NAME .Nm pthread_switch_add_np , .Nm pthread_switch_delete_np -.Nd threads context switches debugging primitives +.Nd thread context switches debugging primitives .Sh LIBRARY .Lb libc_r .Sh SYNOPSIS @@ -40,22 +40,22 @@ .Ft int .Fn pthread_switch_delete_np "pthread_switch_routine_t routine" .Sh DESCRIPTION -The application is allowed to monitor thread context switches inside -threading library. -An application can install routine that gets called everytime a thread -(explicitly created by the application with -.Fn pthread_create -function) gets context switched. -This routine gets passed the pthread IDs of the threads that are +An application is allowed to monitor the thread context switches inside +the threading library. +An application can install a routine that gets called every time a thread +(explicitly created by an application with the +.Xr pthread_create 3 +function) gets the context switched. +The routine is passed the thread IDs of the threads that are being switched in and out. -Installation and removal of these hooks may be done using +Installation and removal of these hooks may be done using the .Fn pthread_switch_add_np and .Fn pthread_switch_delete_np functions respectively. .Sh RETURN VALUES If successful, -functions return 0. +these functions return 0. Otherwise, an error number is returned to indicate the error. .Sh ERRORS The @@ -63,25 +63,25 @@ The may fail if: .Bl -tag -width Er .It Bq Er EINVAL -NULL pointer passed as +.Dv NULL +pointer was passed in the .Fa routine argument. .El +.Pp The .Fn pthread_switch_delete_np may fail if: .Bl -tag -width Er .It Bq Er EINVAL +The .Fa routine -argument is different from argument previously passed to +argument is different from the argument previously passed to the .Fn pthread_switch_add_np +function. .El .Sh SEE ALSO .Xr pthread_create 3 .Sh AUTHORS -The -.Nm -manpage was written by -.An Alexey Zelkin -.Aq phantom@FreeBSD.org - +This manual page was written by +.An Alexey Zelkin Aq phantom@FreeBSD.org . diff --git a/lib/libc_r/man/sem_open.3 b/lib/libc_r/man/sem_open.3 index ff358f7..6beee26 100644 --- a/lib/libc_r/man/sem_open.3 +++ b/lib/libc_r/man/sem_open.3 @@ -128,9 +128,7 @@ and the global variable .Va errno is set to indicate the error. .Pp -.Rv -std sem_close -.Pp -.Rv -std sem_unlink +.Rv -std sem_close sem_unlink .Sh ERRORS The .Fn sem_open @@ -204,9 +202,9 @@ The named semaphore does not exist. .Xr umask 2 , .Xr unlink 2 , .Xr sem_getvalue 3 , -.Xr sem_wait 3 , -.Xr sem_trywait 3 , .Xr sem_post 3 , +.Xr sem_trywait 3 , +.Xr sem_wait 3 , .Xr sem 4 .Sh STANDARDS The @@ -225,4 +223,5 @@ This implementation places strict requirements on the value of it must begin with a slash .Pq Ql / , contain no other slash characters, -and be less than 14 characters in length not including the terminating null. +and be less than 14 characters in length +not including the terminating null character. diff --git a/lib/libgeom/libgeom.3 b/lib/libgeom/libgeom.3 index 78622a0..ff8b5fd 100644 --- a/lib/libgeom/libgeom.3 +++ b/lib/libgeom/libgeom.3 @@ -44,14 +44,14 @@ .Lb libgeom .Sh SYNOPSIS .In libgeom.h -.Ss "Statistics functions" +.Ss "Statistics Functions" .Ft void .Fn geom_stats_close void .Ft int .Fn geom_stats_open void .Ft void .Fn geom_stats_resync void -.Ft void * +.Ft "void *" .Fn geom_stats_snapshot_get void .Ft void .Fn geom_stats_snapshot_free "void *arg" @@ -59,26 +59,30 @@ .Fn geom_stats_snapshot_timestamp "void *arg" "struct timespec *tp" .Ft void .Fn geom_stats_snapshot_reset "void *arg" -.Ft struct g_stat * +.Ft "struct g_stat *" .Fn geom_stats_snapshot_next "void *arg" .Sh DESCRIPTION -.Nm Libgeom -is the library which contains the official and publicized API for +The +.Nm geom +library contains the official and publicized API for interacting with the GEOM subsystem in the kernel. -.Ss "Statistics functions" +.Ss "Statistics Functions" GEOM collects statistics data for all consumers and providers, but does not perform any normalization or presentation on the raw data, this is left as an excercize for user-land presentation utilities. .Pp The .Fn geom_stats_open -and +and .Fn geom_stats_close -functions opens and closes the necessary pathways to access the raw -statistics information in the kernel. These functions are likely to -open one or more files and cache the filedescriptors locally. +functions open and close the necessary pathways to access the raw +statistics information in the kernel. +These functions are likely to +open one or more files and cache the file descriptors locally. .Fn geom_stats_open -returns zero on success, and sets errno if not. +returns zero on success, and sets +.Va errno +if not. .Pp The .Fn geom_stats_resync @@ -88,30 +92,45 @@ added in the kernel since or the previous call to .Fn geom_stats_resync . .Pp +The .Fn geom_stats_snapshot_get -will aquire a snapshot of the raw data from the kernel and while a +function +will acquire a snapshot of the raw data from the kernel, and while a reasonable effort is made to make this snapshot as atomic and consistent as possible, no guarantee is given that it will actually be so. The snapshot must be freed again using the .Fn geom_stats_snapshot_free function. .Fn geom_stats_snapshot_get -returns NULL on failure. +returns +.Dv NULL +on failure. .Pp +The .Fn geom_stats_snapshot_timestamp -provides access to the timestamp aquired in the snapshot. +function +provides access to the timestamp acquired in the snapshot. .Pp +The .Fn geom_stats_snapshot_reset and .Fn geom_stats_snapshot_next -provides an iterator over the statistics slots in the snapshot. +functions +provide an iterator over the statistics slots in the snapshot. +The .Fn geom_stats_snapshot_reset +function forces the internal pointer in the snapshot back to before the first item. +The .Fn geom_stats_snapshot_next -returns the next item and NULL if there are no more items in the snapshot. +function +returns the next item, and +.Dv NULL +if there are no more items in the snapshot. .Sh AUTHORS .An Poul-Henning Kamp Aq phk@FreeBSD.org .Sh HISTORY +The .Nm geom -library appeard in +library appeared in .Fx 5.1 . |