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/libc_r/man | |
parent | 83d0e58172de7563f59519892b23c2fd0e80ca56 (diff) | |
download | FreeBSD-src-0dea5415679a9db700f2846b28d2d8ff833032c7.zip FreeBSD-src-0dea5415679a9db700f2846b28d2d8ff833032c7.tar.gz |
mdoc(7) police: Scheduled sweep.
Diffstat (limited to 'lib/libc_r/man')
-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 |
13 files changed, 124 insertions, 154 deletions
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. |