Hide the implementation details about multiple threading libraries

from the synopses of pthread*(3) manpages. Reviewed by: deischen, davidxu
2007-10-22 10:08:01 +00:00 · 2007-10-22 10:08:01 +00:00 · 8b43f8a980
commit 8b43f8a980
parent a9ab346d8b
60 changed files with 11 additions and 71 deletions
--- a/share/man/man3/pthread.3
+++ b/share/man/man3/pthread.3
@ -30,7 +30,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd January 15, 2004
+.Dd October 19, 2007
 .Dt PTHREAD 3
 .Os
 .Sh NAME
@ -38,7 +38,6 @@
 .Nd POSIX thread functions
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Sh DESCRIPTION
@ -467,13 +466,13 @@ stack and optionally invoke it.
 Push the specified cancellation cleanup handler onto the calling thread's
 cancellation stack.
 .El
-.Sh INSTALLATION
+.Sh IMPLEMENTATION NOTES
 The current
 .Fx
 POSIX thread implementation is built in two libraries,
-.Lb libpthread ,
+.Lb libthr ,
 and
-.Lb libthr .
+.Lb libkse .
 They contain both thread-safe versions of
 .Lb libc
 functions and the thread functions.
--- a/share/man/man3/pthread_attr.3
+++ b/share/man/man3/pthread_attr.3
@ -53,7 +53,6 @@
 .Nd thread attribute operations
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_attr_get_np.3
+++ b/share/man/man3/pthread_attr_get_np.3
@ -32,7 +32,6 @@
 .Nd get attributes of existent thread
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread_np.h
 .Ft int
--- a/share/man/man3/pthread_attr_setcreatesuspend_np.3
+++ b/share/man/man3/pthread_attr_setcreatesuspend_np.3
@ -32,7 +32,6 @@
 .Nd prepare attribute for creation of suspended thread
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread_np.h
 .Ft int
--- a/share/man/man3/pthread_barrier_destroy.3
+++ b/share/man/man3/pthread_barrier_destroy.3
@ -32,7 +32,6 @@
 .Nd "destroy, initialize or wait on a barrier object"
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
@ -77,7 +76,7 @@ argument to
 Once the threads have been released the barrier will be reset.
 .Sh IMPLEMENTATION NOTES
 In both
-.Lb libpthread
+.Lb libkse
 and
 .Lb libthr
 the
@ -150,7 +149,7 @@ The
 and
 .Fn pthread_barrier_wait
 functions first appeared in
-.Lb libpthread
+.Lb libkse
 in
 .Fx 5.2 ,
 and in
--- a/share/man/man3/pthread_barrierattr.3
+++ b/share/man/man3/pthread_barrierattr.3
@ -33,7 +33,6 @@
 .Nd "manipulate a barrier attribute object"
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
@ -125,7 +124,7 @@ is not one of the allowed values.
 The
 .Fn pthread_barrierattr_*
 functions first appeared in
-.Lb libpthread
+.Lb libkse
 in
 .Fx 5.2 ,
 and in
@ -140,7 +139,7 @@ does not fully conform to
 because the process-shared attribute is ignored in
 .Lb libthr ,
 and in
-.Lb libpthread ;
+.Lb libkse ;
 if any value other than
 .Dv PTHREAD_PROCESSES_PRIVATE
 is specified in a call to
--- a/share/man/man3/pthread_cancel.3
+++ b/share/man/man3/pthread_cancel.3
@ -7,7 +7,6 @@
 .Nd cancel execution of a thread
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_cleanup_pop.3
+++ b/share/man/man3/pthread_cleanup_pop.3
@ -35,7 +35,6 @@
 .Nd call the first cleanup routine
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft void
--- a/share/man/man3/pthread_cleanup_push.3
+++ b/share/man/man3/pthread_cleanup_push.3
@ -35,7 +35,6 @@
 .Nd add a cleanup function for thread exit
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft void
--- a/share/man/man3/pthread_cond_broadcast.3
+++ b/share/man/man3/pthread_cond_broadcast.3
@ -35,7 +35,6 @@
 .Nd unblock all threads waiting for a condition variable
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_cond_destroy.3
+++ b/share/man/man3/pthread_cond_destroy.3
@ -35,7 +35,6 @@
 .Nd destroy a condition variable
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_cond_init.3
+++ b/share/man/man3/pthread_cond_init.3
@ -35,7 +35,6 @@
 .Nd create a condition variable
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_cond_signal.3
+++ b/share/man/man3/pthread_cond_signal.3
@ -35,7 +35,6 @@
 .Nd unblock a thread waiting for a condition variable
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_cond_timedwait.3
+++ b/share/man/man3/pthread_cond_timedwait.3
@ -35,7 +35,6 @@
 .Nd "wait on a condition variable for a specific amount of time"
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_cond_wait.3
+++ b/share/man/man3/pthread_cond_wait.3
@ -35,7 +35,6 @@
 .Nd wait on a condition variable
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_condattr.3
+++ b/share/man/man3/pthread_condattr.3
@ -35,7 +35,6 @@
 .Nd condition attribute operations
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_create.3
+++ b/share/man/man3/pthread_create.3
@ -38,7 +38,6 @@
 .Nd create a new thread
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_detach.3
+++ b/share/man/man3/pthread_detach.3
@ -38,7 +38,6 @@
 .Nd detach a thread
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_equal.3
+++ b/share/man/man3/pthread_equal.3
@ -38,7 +38,6 @@
 .Nd compare thread IDs
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_exit.3
+++ b/share/man/man3/pthread_exit.3
@ -38,7 +38,6 @@
 .Nd terminate the calling thread
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft void
--- a/share/man/man3/pthread_getconcurrency.3
+++ b/share/man/man3/pthread_getconcurrency.3
@ -32,7 +32,6 @@
 .Nd get or set level of concurrency
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_getspecific.3
+++ b/share/man/man3/pthread_getspecific.3
@ -38,7 +38,6 @@
 .Nd get a thread-specific data value
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft void *
--- a/share/man/man3/pthread_join.3
+++ b/share/man/man3/pthread_join.3
@ -38,7 +38,6 @@
 .Nd wait for thread termination
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_key_create.3
+++ b/share/man/man3/pthread_key_create.3
@ -38,7 +38,6 @@
 .Nd thread-specific data key creation
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_key_delete.3
+++ b/share/man/man3/pthread_key_delete.3
@ -38,7 +38,6 @@
 .Nd delete a thread-specific data key
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_kill.3
+++ b/share/man/man3/pthread_kill.3
@ -34,7 +34,6 @@
 .Nd send a signal to a specified thread
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .In signal.h
--- a/share/man/man3/pthread_main_np.3
+++ b/share/man/man3/pthread_main_np.3
@ -32,7 +32,6 @@
 .Nd identify the initial thread
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread_np.h
 .Ft int
--- a/share/man/man3/pthread_multi_np.3
+++ b/share/man/man3/pthread_multi_np.3
@ -33,7 +33,6 @@
 .Nd "switch between multi- and single-threaded scheduling modes"
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread_np.h
 .Ft int
--- a/share/man/man3/pthread_mutex_destroy.3
+++ b/share/man/man3/pthread_mutex_destroy.3
@ -35,7 +35,6 @@
 .Nd free resources allocated for a mutex
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_mutex_init.3
+++ b/share/man/man3/pthread_mutex_init.3
@ -35,7 +35,6 @@
 .Nd create a mutex
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_mutex_lock.3
+++ b/share/man/man3/pthread_mutex_lock.3
@ -35,7 +35,6 @@
 .Nd lock a mutex
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_mutex_timedlock.3
+++ b/share/man/man3/pthread_mutex_timedlock.3
@ -32,7 +32,6 @@
 .Nd lock a mutex without blocking indefinitely
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .In time.h
--- a/share/man/man3/pthread_mutex_trylock.3
+++ b/share/man/man3/pthread_mutex_trylock.3
@ -35,7 +35,6 @@
 .Nd attempt to lock a mutex without blocking
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_mutex_unlock.3
+++ b/share/man/man3/pthread_mutex_unlock.3
@ -35,7 +35,6 @@
 .Nd unlock a mutex
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_mutexattr.3
+++ b/share/man/man3/pthread_mutexattr.3
@ -41,7 +41,6 @@
 .Nd mutex attribute operations
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_mutexattr_getkind_np.3
+++ b/share/man/man3/pthread_mutexattr_getkind_np.3
@ -33,7 +33,6 @@
 .Nd mutex attribute operations (legacy)
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread_np.h
 .Ft int
--- a/share/man/man3/pthread_once.3
+++ b/share/man/man3/pthread_once.3
@ -38,7 +38,6 @@
 .Nd dynamic package initialization
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Pp
--- a/share/man/man3/pthread_resume_all_np.3
+++ b/share/man/man3/pthread_resume_all_np.3
@ -32,7 +32,6 @@
 .Nd resume all suspended threads
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread_np.h
 .Ft void
--- a/share/man/man3/pthread_resume_np.3
+++ b/share/man/man3/pthread_resume_np.3
@ -32,7 +32,6 @@
 .Nd resume suspended thread
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread_np.h
 .Ft int
--- a/share/man/man3/pthread_rwlock_destroy.3
+++ b/share/man/man3/pthread_rwlock_destroy.3
@ -32,7 +32,6 @@
 .Nd destroy a read/write lock
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_rwlock_init.3
+++ b/share/man/man3/pthread_rwlock_init.3
@ -32,7 +32,6 @@
 .Nd initialize a read/write lock
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_rwlock_rdlock.3
+++ b/share/man/man3/pthread_rwlock_rdlock.3
@ -33,7 +33,6 @@
 .Nd acquire a read/write lock for reading
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_rwlock_timedrdlock.3
+++ b/share/man/man3/pthread_rwlock_timedrdlock.3
@ -32,7 +32,6 @@
 .Nd "acquire a read-write lock for reading or give up after a specified period"
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_rwlock_timedwrlock.3
+++ b/share/man/man3/pthread_rwlock_timedwrlock.3
@ -32,7 +32,6 @@
 .Nd "acquire a read-write lock for writing or give up after a specified period"
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_rwlock_unlock.3
+++ b/share/man/man3/pthread_rwlock_unlock.3
@ -32,7 +32,6 @@
 .Nd release a read/write lock
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_rwlock_wrlock.3
+++ b/share/man/man3/pthread_rwlock_wrlock.3
@ -33,7 +33,6 @@
 .Nd acquire a read/write lock for writing
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_rwlockattr_destroy.3
+++ b/share/man/man3/pthread_rwlockattr_destroy.3
@ -32,7 +32,6 @@
 .Nd destroy a read/write lock
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_rwlockattr_getpshared.3
+++ b/share/man/man3/pthread_rwlockattr_getpshared.3
@ -32,7 +32,6 @@
 .Nd get the process shared attribute
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_rwlockattr_init.3
+++ b/share/man/man3/pthread_rwlockattr_init.3
@ -32,7 +32,6 @@
 .Nd initialize a read/write lock
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_rwlockattr_setpshared.3
+++ b/share/man/man3/pthread_rwlockattr_setpshared.3
@ -32,7 +32,6 @@
 .Nd set the process shared attribute
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_schedparam.3
+++ b/share/man/man3/pthread_schedparam.3
@ -36,7 +36,6 @@
 .Nd thread scheduling parameter manipulation
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_self.3
+++ b/share/man/man3/pthread_self.3
@ -38,7 +38,6 @@
 .Nd get the calling thread's ID
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft pthread_t
--- a/share/man/man3/pthread_set_name_np.3
+++ b/share/man/man3/pthread_set_name_np.3
@ -32,7 +32,6 @@
 .Nd set the thread name
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread_np.h
 .Ft void
--- a/share/man/man3/pthread_setspecific.3
+++ b/share/man/man3/pthread_setspecific.3
@ -38,7 +38,6 @@
 .Nd set a thread-specific data value
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_sigmask.3
+++ b/share/man/man3/pthread_sigmask.3
@ -34,7 +34,6 @@
 .Nd examine and/or change a thread's signal mask
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .In signal.h
--- a/share/man/man3/pthread_spin_init.3
+++ b/share/man/man3/pthread_spin_init.3
@ -32,7 +32,6 @@
 .Nd "initialize or destroy a spin lock"
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
@ -115,7 +114,7 @@ The
 and
 .Fn pthread_spin_destroy
 functions first appeared in
-.Lb libpthread
+.Lb libkse
 in
 .Fx 5.2 ,
 and in
@ -132,7 +131,7 @@ because the
 argument is ignored in
 .Lb libthr ,
 and in
-.Lb libpthread
+.Lb libkse
 if any value other than
 .Dv PTHREAD_PROCESSES_PRIVATE
 is specified, it returns
--- a/share/man/man3/pthread_spin_lock.3
+++ b/share/man/man3/pthread_spin_lock.3
@ -32,7 +32,6 @@
 .Nd "lock or unlock a spin lock"
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
@ -122,7 +121,7 @@ The
 and
 .Fn pthread_spin_unlock
 functions first appeared in
-.Lb libpthread
+.Lb libkse
 in
 .Fx 5.2 ,
 and in
--- a/share/man/man3/pthread_switch_add_np.3
+++ b/share/man/man3/pthread_switch_add_np.3
@ -33,7 +33,6 @@
 .Nd thread context switches debugging primitives
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread_np.h
 .Ft int
--- a/share/man/man3/pthread_testcancel.3
+++ b/share/man/man3/pthread_testcancel.3
@ -9,7 +9,6 @@
 .Nd set cancelability state
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft int
--- a/share/man/man3/pthread_yield.3
+++ b/share/man/man3/pthread_yield.3
@ -12,7 +12,6 @@
 .Nd yield control of the current thread
 .Sh LIBRARY
 .Lb libpthread
-.Lb libthr
 .Sh SYNOPSIS
 .In pthread.h
 .Ft void