[src/trunk]: src/lib/libpthread Enumerate the functions in a table instead of...

[jruoho <jruoho%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/d64339d7aa91
branches:  trunk
changeset: 754929:d64339d7aa91
user:      jruoho <jruoho%NetBSD.org@localhost>
date:      Sun May 16 12:20:00 2010 +0000

description:
Enumerate the functions in a table instead of a big SEE ALSO.
Also some stylistic changes.

diffstat:

 lib/libpthread/pthread.3 |  115 ++++++++++++++++++++++++----------------------
 1 files changed, 61 insertions(+), 54 deletions(-)

diffs (160 lines):

diff -r 94b7f5e78623 -r d64339d7aa91 lib/libpthread/pthread.3
--- a/lib/libpthread/pthread.3  Sun May 16 11:37:06 2010 +0000
+++ b/lib/libpthread/pthread.3  Sun May 16 12:20:00 2010 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: pthread.3,v 1.12 2009/10/05 23:35:42 rmind Exp $
+.\"    $NetBSD: pthread.3,v 1.13 2010/05/16 12:20:00 jruoho Exp $
 .\"
 .\" Copyright (c) 2003, 2007, 2009 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -27,7 +27,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd October 6, 2009
+.Dd May 16, 2010
 .Dt PTHREAD 3
 .Os
 .Sh NAME
@@ -66,24 +66,74 @@
 Statically linked programs using the
 .Tn POSIX
 threads framework may not work when run on a future version of the system.
+.Sh FUNCTIONS
+The following functions comprise the core of the
+.Nm
+library:
+.Bl -column -offset indent "pthread_barrier_destroy(3)" "XXX"
+.It Sy Function Ta Sy Description
+.It Xr pthread_attr 3 Ta thread attribute operations
+.It Xr pthread_barrier_destroy 3 Ta destroy a barrier
+.It Xr pthread_barrier_init 3 Ta create a barrier
+.It Xr pthread_barrier_wait 3 Ta wait for a barrier
+.It Xr pthread_barrierattr 3 Ta barrier attribute operations
+.It Xr pthread_cancel 3 Ta cancel the execution of a thread
+.It Xr pthread_cleanup_push 3 Ta add or remove cleanup functions
+.It Xr pthread_cond_broadcast 3 Ta unblock one or more threads
+.It Xr pthread_cond_destroy 3 Ta destroy a condition variable
+.It Xr pthread_cond_init 3 Ta create a condition variable
+.It Xr pthread_cond_wait 3 Ta wait for a condition variable
+.It Xr pthread_condattr 3 Ta condition attribute operations
+.It Xr pthread_create 3 Ta create a new thread
+.It Xr pthread_detach 3 Ta detach a thread
+.It Xr pthread_equal 3 Ta compare thread identifiers
+.It Xr pthread_exit 3 Ta terminate the calling thread
+.It Xr pthread_getspecific 3 Ta get a thread-specific data value
+.It Xr pthread_join 3 Ta wait for thread termination
+.It Xr pthread_key_create 3 Ta thread-specific data key creation
+.It Xr pthread_key_delete 3 Ta delete a thread-specific data key
+.It Xr pthread_kill 3 Ta send a signal to a specific thread
+.It Xr pthread_mutex_destroy 3 Ta free a mutex
+.It Xr pthread_mutex_init 3 Ta create a mutex
+.It Xr pthread_mutex_lock 3 Ta acquire a lock on a mutex
+.It Xr pthread_mutex_unlock 3 Ta unlock a mutex
+.It Xr pthread_mutexattr 3 Ta mutex attribute operations
+.It Xr pthread_once 3 Ta dynamic package initialization
+.It Xr pthread_rwlock_destroy 3 Ta destroy a read/write lock
+.It Xr pthread_rwlock_init 3 Ta initialize a read/write lock
+.It Xr pthread_rwlock_rdlock 3 Ta acquire a read/write lock for reading
+.It Xr pthread_rwlock_unlock 3 Ta release a read/write lock
+.It Xr pthread_rwlock_wrlock 3 Ta acquire a read/write lock for writing
+.It Xr pthread_rwlockattr 3 Ta read/write lock attribute operations
+.It Xr pthread_schedparam 3 Ta thread scheduling manipulation
+.It Xr pthread_self 3 Ta get the ID of the calling thread
+.It Xr pthread_setspecific 3 Ta get a thread-specific data value
+.It Xr pthread_sigmask 3 Ta manipulate a thread's signal mask
+.It Xr pthread_spin_destroy 3 Ta destroy a spin lock
+.It Xr pthread_spin_init 3 Ta initialize a spin lock
+.It Xr pthread_spin_lock 3 Ta acquire a spin lock
+.It Xr pthread_spin_unlock 3 Ta release a spin lock
+.It Xr pthread_testcancel 3 Ta set cancelability state
+.El
 .Sh ENVIRONMENT
-.Bl -tag -width PTHREAD_DEBUGCOUNTERSXX
+The following environment variables affect the behavior of the library:
+.Bl -tag -width "XXX"
 .It Ev PTHREAD_DIAGASSERT
 Possible values are any combinations of:
 .Pp
-.Bl -tag -width ignoreXX -offset indent -compact
-.It Sy A
+.Bl -tag -width "X " -offset 1n -compact
+.It Em A
 Report errors to application by error return, but do not abort.
-.It Sy a
+.It Em a
 Abort on errors, creating a core dump for further debugging.
-.It Sy E
+.It Em E
 Do not log errors to stdout.
-.It Sy e
+.It Em e
 Log errors to stdout.
-.It Sy L
+.It Em L
 Do not log errors via
 .Xr syslogd 8 .
-.It Sy l
+.It Em l
 Log errors via
 .Xr syslogd 8 .
 .El
@@ -91,7 +141,7 @@
 If not set in the environment, the
 .Nm
 library behaves as if
-.Sy AEL
+.Em AEL
 has been specified.
 .It Ev PTHREAD_STACKSIZE
 Integer value giving the stack size in kilobytes.
@@ -106,49 +156,6 @@
 for
 .Xr sh 1 ) .
 .El
-.Sh SEE ALSO
-.Xr pthread_attr 3 ,
-.Xr pthread_barrier_destroy 3 ,
-.Xr pthread_barrier_init 3 ,
-.Xr pthread_barrier_wait 3 ,
-.Xr pthread_barrierattr 3 ,
-.Xr pthread_cancel 3 ,
-.Xr pthread_cleanup_push 3 ,
-.Xr pthread_cond_broadcast 3 ,
-.Xr pthread_cond_destroy 3 ,
-.Xr pthread_cond_init 3 ,
-.Xr pthread_cond_wait 3 ,
-.Xr pthread_condattr 3 ,
-.Xr pthread_create 3 ,
-.Xr pthread_detach 3 ,
-.Xr pthread_equal 3 ,
-.Xr pthread_exit 3 ,
-.Xr pthread_getspecific 3 ,
-.Xr pthread_join 3 ,
-.Xr pthread_key_create 3 ,
-.Xr pthread_key_delete 3 ,
-.Xr pthread_kill 3 ,
-.Xr pthread_mutex_destroy 3 ,
-.Xr pthread_mutex_init 3 ,
-.Xr pthread_mutex_lock 3 ,
-.Xr pthread_mutex_unlock 3 ,
-.Xr pthread_mutexattr 3 ,
-.Xr pthread_once 3 ,
-.Xr pthread_rwlock_destroy 3 ,
-.Xr pthread_rwlock_init 3 ,
-.Xr pthread_rwlock_rdlock 3 ,
-.Xr pthread_rwlock_unlock 3 ,
-.Xr pthread_rwlock_wrlock 3 ,
-.Xr pthread_rwlockattr 3 ,
-.Xr pthread_schedparam 3 ,
-.Xr pthread_self 3 ,
-.Xr pthread_setspecific 3 ,
-.Xr pthread_sigmask 3 ,
-.Xr pthread_spin_destroy 3 ,
-.Xr pthread_spin_init 3 ,
-.Xr pthread_spin_lock 3 ,
-.Xr pthread_spin_unlock 3 ,
-.Xr pthread_testcancel 3
 .Sh STANDARDS
 The
 .Nm