summaryrefslogtreecommitdiff
path: root/lib/libpthread/man/pthread_key_create.3
diff options
context:
space:
mode:
authorMike Pechkin <mpech@cvs.openbsd.org>2002-05-01 08:03:31 +0000
committerMike Pechkin <mpech@cvs.openbsd.org>2002-05-01 08:03:31 +0000
commit41434dbdbf3099a023505b5b3915bf4d9b778ee1 (patch)
tree1ca936fb3301ad4347fcc3a38fd2c83e87a15817 /lib/libpthread/man/pthread_key_create.3
parent04e9f1abe6384e852ca0207d882814dab9237dd4 (diff)
o) start new sentence on a new line;
o) always close .Bl tags; o) fix usage of .Xr; millert@ ok
Diffstat (limited to 'lib/libpthread/man/pthread_key_create.3')
-rw-r--r--lib/libpthread/man/pthread_key_create.326
1 files changed, 15 insertions, 11 deletions
diff --git a/lib/libpthread/man/pthread_key_create.3 b/lib/libpthread/man/pthread_key_create.3
index 08ba9ea7e3e..0f5aa51c5dc 100644
--- a/lib/libpthread/man/pthread_key_create.3
+++ b/lib/libpthread/man/pthread_key_create.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: pthread_key_create.3,v 1.6 2002/02/21 20:12:19 fgsch Exp $
+.\" $OpenBSD: pthread_key_create.3,v 1.7 2002/05/01 08:03:30 mpech Exp $
.\"
.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
.\" All rights reserved.
@@ -46,9 +46,11 @@
The
.Fn pthread_key_create
function creates a thread-specific data key visible to all threads in the
-process. Key values provided by
+process.
+Key values provided by
.Fn pthread_key_create
-are opaque objects used to locate thread-specific data. Although the same
+are opaque objects used to locate thread-specific data.
+Although the same
key value may be used by different threads, the values bound to the key
by
.Fn pthread_setspecific
@@ -56,19 +58,21 @@ are maintained on a per-thread basis and persist for the life of the calling
thread.
.Pp
Upon key creation, the value NULL is associated with the new key in all
-active threads. Upon thread creation, the value NULL is associated with all
+active threads.
+Upon thread creation, the value NULL 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
+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
-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
+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 at least
+associated destructors, then the process is repeated.
+If, after at least
[PTHREAD_DESTRUCTOR_ITERATIONS] iterations of destructor calls for
outstanding non-NULL values, there are still some non-NULL values with
associated destructors, the implementation stops calling destructors.
@@ -77,8 +81,8 @@ If successful, the
.Fn pthread_key_create
function will store the newly created key value at the location specified by
.Fa key
-and returns zero. Otherwise an error number will be returned to indicate
-the error.
+and returns zero.
+Otherwise an error number will be returned to indicate the error.
.Sh ERRORS
.Fn pthread_key_create
will fail if: