summaryrefslogtreecommitdiff
path: root/lib/libpthread
diff options
context:
space:
mode:
authorwiz <wiz@NetBSD.org>2010-07-09 10:55:11 +0000
committerwiz <wiz@NetBSD.org>2010-07-09 10:55:11 +0000
commit83d2a68694fcae51e5dd0424327b6dcd32a815cd (patch)
tree4af3f7559a8f43694d646080ad1949341c2cd6a9 /lib/libpthread
parentf42b354e7da2bde7d2a601ba3ee5068407ed940d (diff)
Mark up NULL.
Diffstat (limited to 'lib/libpthread')
-rw-r--r--lib/libpthread/pthread_cond.36
-rw-r--r--lib/libpthread/pthread_join.35
-rw-r--r--lib/libpthread/pthread_key_create.328
-rw-r--r--lib/libpthread/pthread_mutex.36
-rw-r--r--lib/libpthread/pthread_rwlock.36
-rw-r--r--lib/libpthread/pthread_sigmask.36
-rw-r--r--lib/libpthread/pthread_spin.36
7 files changed, 42 insertions, 21 deletions
diff --git a/lib/libpthread/pthread_cond.3 b/lib/libpthread/pthread_cond.3
index 0faeffa6afc..965a24aea78 100644
--- a/lib/libpthread/pthread_cond.3
+++ b/lib/libpthread/pthread_cond.3
@@ -1,4 +1,4 @@
-.\" $NetBSD: pthread_cond.3,v 1.2 2010/07/08 21:34:06 wiz Exp $
+.\" $NetBSD: pthread_cond.3,v 1.3 2010/07/09 10:55:11 wiz Exp $
.\"
.\" Copyright (c) 2002, 2008 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -88,7 +88,9 @@ function creates a new condition variable, with attributes specified with
.Fa attr .
If
.Fa attr
-is NULL the default attributes are used.
+is
+.Dv NULL
+the default attributes are used.
.Pp
Condition variables are intended to be used to communicate changes in
the state of data shared between threads.
diff --git a/lib/libpthread/pthread_join.3 b/lib/libpthread/pthread_join.3
index 9f2545af74e..41609f65c6d 100644
--- a/lib/libpthread/pthread_join.3
+++ b/lib/libpthread/pthread_join.3
@@ -1,4 +1,4 @@
-.\" $NetBSD: pthread_join.3,v 1.5 2010/07/09 08:51:28 jruoho Exp $
+.\" $NetBSD: pthread_join.3,v 1.6 2010/07/09 10:55:11 wiz Exp $
.\"
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -78,7 +78,8 @@ has already terminated.
.Pp
On return from a successful
.Fn pthread_join
-call with a non-NULL
+call with a
+.Pf non- Dv NULL
.Fa value_ptr
argument, the value passed to
.Fn pthread_exit
diff --git a/lib/libpthread/pthread_key_create.3 b/lib/libpthread/pthread_key_create.3
index 6dc0f9d0782..05f72eac51d 100644
--- a/lib/libpthread/pthread_key_create.3
+++ b/lib/libpthread/pthread_key_create.3
@@ -1,4 +1,4 @@
-.\" $NetBSD: pthread_key_create.3,v 1.5 2010/07/09 08:22:04 jruoho Exp $
+.\" $NetBSD: pthread_key_create.3,v 1.6 2010/07/09 10:55:11 wiz Exp $
.\"
.\" Copyright (c) 2002, 2010 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -90,19 +90,27 @@ is associated with all
defined keys in the new thread.
.Pp
An optional destructor function may be associated with each key value.
-At thread exit, if a key value has a non-NULL destructor pointer, and the
-thread has a non-NULL value associated with the key, the function pointed
+At thread exit, if a key value has a
+.Pf non- Dv NULL
+destructor pointer, and the thread has a
+.Pf non- Dv NULL
+value associated with the key, the function pointed
to is called with the current associated value as its sole argument.
The order of destructor calls is unspecified if more
than one destructor exists for a thread when it exits.
.Pp
-If, after all the destructors have been called for all non-NULL values
-with associated destructors, there are still some non-NULL values with
-associated destructors, then the process is repeated.
+If, after all the destructors have been called for all
+.Pf non- Dv NULL
+values with associated destructors, there are still some
+.Pf non- Dv NULL
+values with associated destructors, then the process is repeated.
If, after at least
.Dv PTHREAD_DESTRUCTOR_ITERATIONS
-iterations of destructor calls for
-outstanding non-NULL values, there are still some non-NULL values with
+iterations of destructor calls for outstanding
+.Pf non- Dv NULL
+values, there are still some
+.Pf non- Dv NULL
+values with
associated destructors, the implementation stops calling destructors.
.Pp
The
@@ -111,7 +119,9 @@ function deletes a thread-specific data key previously returned by
.Fn pthread_key_create .
The thread-specific data values associated with
.Fa key
-need not be NULL at the time of the call.
+need not be
+.Dv NULL
+at the time of the call.
It is the responsibility of the application to free any
application storage or perform any cleanup actions for data structures
related to the deleted key or associated thread-specific data in any threads;
diff --git a/lib/libpthread/pthread_mutex.3 b/lib/libpthread/pthread_mutex.3
index d05ecfd0f22..0baa452ad05 100644
--- a/lib/libpthread/pthread_mutex.3
+++ b/lib/libpthread/pthread_mutex.3
@@ -1,4 +1,4 @@
-.\" $NetBSD: pthread_mutex.3,v 1.4 2010/07/08 21:34:22 wiz Exp $
+.\" $NetBSD: pthread_mutex.3,v 1.5 2010/07/09 10:55:11 wiz Exp $
.\"
.\" Copyright (c) 2002, 2010 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -84,7 +84,9 @@ function creates a new mutex, with attributes specified with
.Fa attr .
If
.Fa attr
-is NULL the default attributes are used.
+is
+.Dv NULL ,
+the default attributes are used.
.Pp
The macro
.Dv PTHREAD_MUTEX_INITIALIZER
diff --git a/lib/libpthread/pthread_rwlock.3 b/lib/libpthread/pthread_rwlock.3
index 3b2f2943033..b9b9b73890e 100644
--- a/lib/libpthread/pthread_rwlock.3
+++ b/lib/libpthread/pthread_rwlock.3
@@ -1,4 +1,4 @@
-.\" $NetBSD: pthread_rwlock.3,v 1.2 2010/07/08 21:34:48 wiz Exp $
+.\" $NetBSD: pthread_rwlock.3,v 1.3 2010/07/09 10:55:11 wiz Exp $
.\"
.\" Copyright (c) 2002, 2010 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -92,7 +92,9 @@ specified by
.Fa attr .
If
.Fa attr
-is NULL, the default read/write lock attributes are used.
+is
+.Dv NULL ,
+the default read/write lock attributes are used.
.Pp
The results of calling
.Fn pthread_rwlock_init
diff --git a/lib/libpthread/pthread_sigmask.3 b/lib/libpthread/pthread_sigmask.3
index c9a2145d720..3286e11ca63 100644
--- a/lib/libpthread/pthread_sigmask.3
+++ b/lib/libpthread/pthread_sigmask.3
@@ -1,4 +1,4 @@
-.\" $NetBSD: pthread_sigmask.3,v 1.8 2010/07/09 08:51:28 jruoho Exp $
+.\" $NetBSD: pthread_sigmask.3,v 1.9 2010/07/09 10:55:11 wiz Exp $
.\"
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -88,7 +88,9 @@ Intersection of the current mask and the complement of
.Pp
If
.Fa oset
-is not NULL, the previous signal mask is stored in the location pointed to by
+is not
+.Dv NULL ,
+the previous signal mask is stored in the location pointed to by
.Fa oset .
.Pp
.Dv SIGKILL
diff --git a/lib/libpthread/pthread_spin.3 b/lib/libpthread/pthread_spin.3
index 0bebabd71c7..a687ea2ac04 100644
--- a/lib/libpthread/pthread_spin.3
+++ b/lib/libpthread/pthread_spin.3
@@ -1,4 +1,4 @@
-.\" $NetBSD: pthread_spin.3,v 1.4 2010/07/09 08:31:35 wiz Exp $
+.\" $NetBSD: pthread_spin.3,v 1.5 2010/07/09 10:55:11 wiz Exp $
.\"
.\" Copyright (c) 2002, 2008, 2010 The NetBSD Foundation, Inc.
.\" All rights reserved.
@@ -118,7 +118,9 @@ function may fail if:
.It Bq Er EINVAL
The
.Fa lock
-parameter was NULL or the
+parameter was
+.Dv NULL
+or the
.Fa pshared
parameter was neither
.Dv PTHREAD_PROCESS_SHARED