Hide the implementation details about multiple threading libraries

from the synopses of pthread*(3) manpages.

Reviewed by:	deischen, davidxu
This commit is contained in:
Ruslan Ermilov 2007-10-22 10:08:01 +00:00
parent d8e438f0d5
commit 3e9ed1efb8
60 changed files with 11 additions and 71 deletions

View File

@ -30,7 +30,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd January 15, 2004 .Dd October 19, 2007
.Dt PTHREAD 3 .Dt PTHREAD 3
.Os .Os
.Sh NAME .Sh NAME
@ -38,7 +38,6 @@
.Nd POSIX thread functions .Nd POSIX thread functions
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Sh DESCRIPTION .Sh DESCRIPTION
@ -467,13 +466,13 @@ stack and optionally invoke it.
Push the specified cancellation cleanup handler onto the calling thread's Push the specified cancellation cleanup handler onto the calling thread's
cancellation stack. cancellation stack.
.El .El
.Sh INSTALLATION .Sh IMPLEMENTATION NOTES
The current The current
.Fx .Fx
POSIX thread implementation is built in two libraries, POSIX thread implementation is built in two libraries,
.Lb libpthread , .Lb libthr ,
and and
.Lb libthr . .Lb libkse .
They contain both thread-safe versions of They contain both thread-safe versions of
.Lb libc .Lb libc
functions and the thread functions. functions and the thread functions.

View File

@ -53,7 +53,6 @@
.Nd thread attribute operations .Nd thread attribute operations
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd get attributes of existent thread .Nd get attributes of existent thread
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread_np.h .In pthread_np.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd prepare attribute for creation of suspended thread .Nd prepare attribute for creation of suspended thread
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread_np.h .In pthread_np.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd "destroy, initialize or wait on a barrier object" .Nd "destroy, initialize or wait on a barrier object"
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int
@ -77,7 +76,7 @@ argument to
Once the threads have been released the barrier will be reset. Once the threads have been released the barrier will be reset.
.Sh IMPLEMENTATION NOTES .Sh IMPLEMENTATION NOTES
In both In both
.Lb libpthread .Lb libkse
and and
.Lb libthr .Lb libthr
the the
@ -150,7 +149,7 @@ The
and and
.Fn pthread_barrier_wait .Fn pthread_barrier_wait
functions first appeared in functions first appeared in
.Lb libpthread .Lb libkse
in in
.Fx 5.2 , .Fx 5.2 ,
and in and in

View File

@ -33,7 +33,6 @@
.Nd "manipulate a barrier attribute object" .Nd "manipulate a barrier attribute object"
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int
@ -125,7 +124,7 @@ is not one of the allowed values.
The The
.Fn pthread_barrierattr_* .Fn pthread_barrierattr_*
functions first appeared in functions first appeared in
.Lb libpthread .Lb libkse
in in
.Fx 5.2 , .Fx 5.2 ,
and in and in
@ -140,7 +139,7 @@ does not fully conform to
because the process-shared attribute is ignored in because the process-shared attribute is ignored in
.Lb libthr , .Lb libthr ,
and in and in
.Lb libpthread ; .Lb libkse ;
if any value other than if any value other than
.Dv PTHREAD_PROCESSES_PRIVATE .Dv PTHREAD_PROCESSES_PRIVATE
is specified in a call to is specified in a call to

View File

@ -7,7 +7,6 @@
.Nd cancel execution of a thread .Nd cancel execution of a thread
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd call the first cleanup routine .Nd call the first cleanup routine
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft void .Ft void

View File

@ -35,7 +35,6 @@
.Nd add a cleanup function for thread exit .Nd add a cleanup function for thread exit
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft void .Ft void

View File

@ -35,7 +35,6 @@
.Nd unblock all threads waiting for a condition variable .Nd unblock all threads waiting for a condition variable
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd destroy a condition variable .Nd destroy a condition variable
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd create a condition variable .Nd create a condition variable
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd unblock a thread waiting for a condition variable .Nd unblock a thread waiting for a condition variable
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd "wait on a condition variable for a specific amount of time" .Nd "wait on a condition variable for a specific amount of time"
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd wait on a condition variable .Nd wait on a condition variable
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd condition attribute operations .Nd condition attribute operations
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -38,7 +38,6 @@
.Nd create a new thread .Nd create a new thread
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -38,7 +38,6 @@
.Nd detach a thread .Nd detach a thread
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -38,7 +38,6 @@
.Nd compare thread IDs .Nd compare thread IDs
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -38,7 +38,6 @@
.Nd terminate the calling thread .Nd terminate the calling thread
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft void .Ft void

View File

@ -32,7 +32,6 @@
.Nd get or set level of concurrency .Nd get or set level of concurrency
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -38,7 +38,6 @@
.Nd get a thread-specific data value .Nd get a thread-specific data value
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft void * .Ft void *

View File

@ -38,7 +38,6 @@
.Nd wait for thread termination .Nd wait for thread termination
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -38,7 +38,6 @@
.Nd thread-specific data key creation .Nd thread-specific data key creation
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -38,7 +38,6 @@
.Nd delete a thread-specific data key .Nd delete a thread-specific data key
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -34,7 +34,6 @@
.Nd send a signal to a specified thread .Nd send a signal to a specified thread
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.In signal.h .In signal.h

View File

@ -32,7 +32,6 @@
.Nd identify the initial thread .Nd identify the initial thread
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread_np.h .In pthread_np.h
.Ft int .Ft int

View File

@ -33,7 +33,6 @@
.Nd "switch between multi- and single-threaded scheduling modes" .Nd "switch between multi- and single-threaded scheduling modes"
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread_np.h .In pthread_np.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd free resources allocated for a mutex .Nd free resources allocated for a mutex
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd create a mutex .Nd create a mutex
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd lock a mutex .Nd lock a mutex
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd lock a mutex without blocking indefinitely .Nd lock a mutex without blocking indefinitely
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.In time.h .In time.h

View File

@ -35,7 +35,6 @@
.Nd attempt to lock a mutex without blocking .Nd attempt to lock a mutex without blocking
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -35,7 +35,6 @@
.Nd unlock a mutex .Nd unlock a mutex
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -41,7 +41,6 @@
.Nd mutex attribute operations .Nd mutex attribute operations
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -33,7 +33,6 @@
.Nd mutex attribute operations (legacy) .Nd mutex attribute operations (legacy)
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread_np.h .In pthread_np.h
.Ft int .Ft int

View File

@ -38,7 +38,6 @@
.Nd dynamic package initialization .Nd dynamic package initialization
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Pp .Pp

View File

@ -32,7 +32,6 @@
.Nd resume all suspended threads .Nd resume all suspended threads
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread_np.h .In pthread_np.h
.Ft void .Ft void

View File

@ -32,7 +32,6 @@
.Nd resume suspended thread .Nd resume suspended thread
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread_np.h .In pthread_np.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd destroy a read/write lock .Nd destroy a read/write lock
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd initialize a read/write lock .Nd initialize a read/write lock
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -33,7 +33,6 @@
.Nd acquire a read/write lock for reading .Nd acquire a read/write lock for reading
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd "acquire a read-write lock for reading or give up after a specified period" .Nd "acquire a read-write lock for reading or give up after a specified period"
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd "acquire a read-write lock for writing or give up after a specified period" .Nd "acquire a read-write lock for writing or give up after a specified period"
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd release a read/write lock .Nd release a read/write lock
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -33,7 +33,6 @@
.Nd acquire a read/write lock for writing .Nd acquire a read/write lock for writing
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd destroy a read/write lock .Nd destroy a read/write lock
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd get the process shared attribute .Nd get the process shared attribute
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd initialize a read/write lock .Nd initialize a read/write lock
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -32,7 +32,6 @@
.Nd set the process shared attribute .Nd set the process shared attribute
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -36,7 +36,6 @@
.Nd thread scheduling parameter manipulation .Nd thread scheduling parameter manipulation
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -38,7 +38,6 @@
.Nd get the calling thread's ID .Nd get the calling thread's ID
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft pthread_t .Ft pthread_t

View File

@ -32,7 +32,6 @@
.Nd set the thread name .Nd set the thread name
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread_np.h .In pthread_np.h
.Ft void .Ft void

View File

@ -38,7 +38,6 @@
.Nd set a thread-specific data value .Nd set a thread-specific data value
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -34,7 +34,6 @@
.Nd examine and/or change a thread's signal mask .Nd examine and/or change a thread's signal mask
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.In signal.h .In signal.h

View File

@ -32,7 +32,6 @@
.Nd "initialize or destroy a spin lock" .Nd "initialize or destroy a spin lock"
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int
@ -115,7 +114,7 @@ The
and and
.Fn pthread_spin_destroy .Fn pthread_spin_destroy
functions first appeared in functions first appeared in
.Lb libpthread .Lb libkse
in in
.Fx 5.2 , .Fx 5.2 ,
and in and in
@ -132,7 +131,7 @@ because the
argument is ignored in argument is ignored in
.Lb libthr , .Lb libthr ,
and in and in
.Lb libpthread .Lb libkse
if any value other than if any value other than
.Dv PTHREAD_PROCESSES_PRIVATE .Dv PTHREAD_PROCESSES_PRIVATE
is specified, it returns is specified, it returns

View File

@ -32,7 +32,6 @@
.Nd "lock or unlock a spin lock" .Nd "lock or unlock a spin lock"
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int
@ -122,7 +121,7 @@ The
and and
.Fn pthread_spin_unlock .Fn pthread_spin_unlock
functions first appeared in functions first appeared in
.Lb libpthread .Lb libkse
in in
.Fx 5.2 , .Fx 5.2 ,
and in and in

View File

@ -33,7 +33,6 @@
.Nd thread context switches debugging primitives .Nd thread context switches debugging primitives
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread_np.h .In pthread_np.h
.Ft int .Ft int

View File

@ -9,7 +9,6 @@
.Nd set cancelability state .Nd set cancelability state
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft int .Ft int

View File

@ -12,7 +12,6 @@
.Nd yield control of the current thread .Nd yield control of the current thread
.Sh LIBRARY .Sh LIBRARY
.Lb libpthread .Lb libpthread
.Lb libthr
.Sh SYNOPSIS .Sh SYNOPSIS
.In pthread.h .In pthread.h
.Ft void .Ft void