aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarlos O'Donell <carlos@redhat.com>2014-02-28 18:30:22 -0500
committerCarlos O'Donell <carlos@redhat.com>2014-02-28 18:30:22 -0500
commitef563f925aae39e57a0e9b3f938861f781d061ba (patch)
tree97080b693a72d078ff108375573e11fdee30875e
parent8e25d1e7721d8078d8925e325799740dd53a5801 (diff)
downloadglibc-ef563f925aae39e57a0e9b3f938861f781d061ba.tar
glibc-ef563f925aae39e57a0e9b3f938861f781d061ba.tar.gz
glibc-ef563f925aae39e57a0e9b3f938861f781d061ba.tar.bz2
glibc-ef563f925aae39e57a0e9b3f938861f781d061ba.zip
Add header and standard information to threads.texi.
The glibc manual uses special annotations to include functions in the summary chapter. These annotations were missing from the functions in the threads chapter. This patch adds those special markers and in turn adds these functions to the summary chapter.
-rw-r--r--ChangeLog3
-rw-r--r--manual/threads.texi12
2 files changed, 15 insertions, 0 deletions
diff --git a/ChangeLog b/ChangeLog
index 60d63dbf88..959f12a1f0 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
2014-02-28 Carlos O'Donell <carlos@redhat.com>
+ * manual/threads.texi: Add header and standard comments to all
+ functions.
+
* elf/dl-lookup.c (check_match): New function.
(ELF_MACHINE_SYM_NO_MATCH): Adjust comment.
(do_lookup_x): Remove nested function check_match. Use non-nested
diff --git a/manual/threads.texi b/manual/threads.texi
index e088b26a15..4d080d44cf 100644
--- a/manual/threads.texi
+++ b/manual/threads.texi
@@ -20,6 +20,8 @@ The @glibcadj{} implements functions to allow users to create and manage
data specific to a thread. Such data may be destroyed at thread exit,
if a destructor is provided. The following functions are defined:
+@comment pthread.h
+@comment POSIX
@deftypefun int pthread_key_create (pthread_key_t *@var{key}, void (*@var{destructor})(void*))
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c pthread_key_create ok
@@ -34,6 +36,8 @@ data destructors or even as members of the thread-specific data, since the
latter is passed as an argument to the destructor function.
@end deftypefun
+@comment pthread.h
+@comment POSIX
@deftypefun int pthread_key_delete (pthread_key_t @var{key})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c pthread_key_delete ok
@@ -45,6 +49,8 @@ destructor for the thread-specific data is not called during destruction, nor
is it called during thread exit.
@end deftypefun
+@comment pthread.h
+@comment POSIX
@deftypefun void *pthread_getspecific (pthread_key_t @var{key})
@safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
@c pthread_getspecific ok
@@ -52,6 +58,8 @@ Return the thread-specific data associated with @var{key} in the calling
thread.
@end deftypefun
+@comment pthread.h
+@comment POSIX
@deftypefun int pthread_setspecific (pthread_key_t @var{key}, const void *@var{value})
@safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{} @ascuheap{}}@acunsafe{@acucorrupt{} @acsmem{}}}
@c pthread_setspecific @asucorrupt @ascuheap @acucorrupt @acsmem
@@ -84,6 +92,8 @@ the standard.
@Theglibc{} provides non-standard API functions to set and get the default
attributes used in the creation of threads in a process.
+@comment pthread.h
+@comment GNU
@deftypefun int pthread_getattr_default_np (pthread_attr_t *@var{attr})
@safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
@c Takes lock around read from default_pthread_attr.
@@ -92,6 +102,8 @@ function returns @math{0} on success and a non-zero error code on
failure.
@end deftypefun
+@comment pthread.h
+@comment GNU
@deftypefun int pthread_setattr_default_np (pthread_attr_t *@var{attr})
@safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{} @asulock{}}@acunsafe{@aculock{} @acsmem{}}}
@c pthread_setattr_default_np @ascuheap @asulock @aculock @acsmem