This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
[COMMITTED] Add magic header/standard comments to functions in threads.texi.
- From: "Carlos O'Donell" <carlos at redhat dot com>
- To: GNU C Library <libc-alpha at sourceware dot org>
- Cc: Siddhesh Poyarekar <siddhesh at redhat dot com>, OndÅej BÃlka <neleai at seznam dot cz>
- Date: Fri, 28 Feb 2014 18:31:51 -0500
- Subject: [COMMITTED] Add magic header/standard comments to functions in threads.texi.
- Authentication-results: sourceware.org; auth=none
The magic header/standard comment is parsed by summary.awk
during the manual generation to produce the summary that
makes up the "Summary of Library Facilities" chapter in the
manual. I didn't even know this was a requirement of getting
the function into that list and I just noticed because I
knew we had pthread_* functions documented but none were in
the list.
Following existing practice I've used "GNU" for functions
that are gnu extensions and don't follow any standard.
I wish we had a test that failed if there functions without
the magic header/standard comment.
Tested by building the pdf and verifying these functions
are now in the summary list.
2014-02-28 Carlos O'Donell <carlos@redhat.com>
* manual/thread.texi: Add header and standard comments to all
functions.
diff --git a/manual/threads.texi b/manual/threads.texi
index e088b26..4d080d4 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
---
Cheers,
Carlos.