about summary refs log tree commit diff
path: root/manual/threads.texi
diff options
context:
space:
mode:
authorRical Jasan <ricaljasan@pacific.net>2017-06-15 21:12:39 -0700
committerRical Jasan <ricaljasan@pacific.net>2017-06-15 21:26:20 -0700
commitd08a7e4cbe43d5e4e4b14dea950fea623d96c1a1 (patch)
tree6f27987046ae0e8804f4d641c99ff1666652117a /manual/threads.texi
parent27691d5cec9b896ea0792151a27c6d7d7a4065ea (diff)
downloadglibc-d08a7e4cbe43d5e4e4b14dea950fea623d96c1a1.tar.gz
glibc-d08a7e4cbe43d5e4e4b14dea950fea623d96c1a1.tar.xz
glibc-d08a7e4cbe43d5e4e4b14dea950fea623d96c1a1.zip
manual: Replace summary.awk with summary.pl.
The Summary is now generated from @standards, and syntax-checking is
performed.  If invalid @standards syntax is detected, summary.pl will
fail, reporting all errors.  Failure and error reporting is disabled
for now, however, since much of the manual is still incomplete
wrt. header and standards annotations.

Note that the sorting order of the Summary has changed; summary.pl
respects the locale, like summary.awk did, but the use of LC_ALL=C is
introduced in the Makefile.  Other notable deviations are improved
detection of the annotated elements' names, which are used for
sorting, and improved detection of the @node used to reference into
the manual.  The most noticeable difference in the rendered Summary is
that entries may now contain multiple lines, one for each header and
standard combination.

summary.pl accepts a `--help' option, which details the expected
syntax of @standards.  If errors are reported, the user is directed to
this feature for further information.

	* manual/Makefile: Generate summary.texi with summary.pl.
	Force use of the C locale.  Update Perl dependency comment.
	* manual/header.texi: Update reference to summary.awk.
	* manual/macros.texi: Refer authors to `summary.pl --help'.
	* manual/summary.awk: Remove file.
	* manual/summary.pl: New file.  Generate summary.texi, and
	check for @standards-related syntax errors.
	* manual/argp.texi: Convert header and standards @comments to
	@standards.
	* manual/arith.texi: Likewise.
	* manual/charset.texi: Likewise.
	* manual/conf.texi: Likewise.
	* manual/creature.texi: Likewise.
	* manual/crypt.texi: Likewise.
	* manual/ctype.texi: Likewise.
	* manual/debug.texi: Likewise.
	* manual/errno.texi: Likewise.
	* manual/filesys.texi: Likewise.
	* manual/getopt.texi: Likewise.
	* manual/job.texi: Likewise.
	* manual/lang.texi: Likewise.
	* manual/llio.texi: Likewise.
	* manual/locale.texi: Likewise.
	* manual/math.texi: Likewise.
	* manual/memory.texi: Likewise.
	* manual/message.texi: Likewise.
	* manual/pattern.texi: Likewise.
	* manual/pipe.texi: Likewise.
	* manual/process.texi: Likewise.
	* manual/resource.texi: Likewise.
	* manual/search.texi: Likewise.
	* manual/setjmp.texi: Likewise.
	* manual/signal.texi: Likewise.
	* manual/socket.texi: Likewise.
	* manual/startup.texi: Likewise.
	* manual/stdio.texi: Likewise.
	* manual/string.texi: Likewise.
	* manual/sysinfo.texi: Likewise.
	* manual/syslog.texi: Likewise.
	* manual/terminal.texi: Likewise.
	* manual/threads.texi: Likewise.
	* manual/time.texi: Likewise.
	* manual/users.texi: Likewise.
Diffstat (limited to 'manual/threads.texi')
-rw-r--r--manual/threads.texi18
1 files changed, 6 insertions, 12 deletions
diff --git a/manual/threads.texi b/manual/threads.texi
index d7fac825c8..769d974d50 100644
--- a/manual/threads.texi
+++ b/manual/threads.texi
@@ -20,9 +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*))
+@standards{POSIX, pthread.h}
 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
 @c pthread_key_create ok
 @c  KEY_UNUSED ok
@@ -36,9 +35,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})
+@standards{POSIX, pthread.h}
 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
 @c pthread_key_delete ok
 @c   This uses atomic compare and exchange to increment the seq number
@@ -49,18 +47,16 @@ 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})
+@standards{POSIX, pthread.h}
 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
 @c pthread_getspecific ok
 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})
+@standards{POSIX, pthread.h}
 @safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{} @ascuheap{}}@acunsafe{@acucorrupt{} @acsmem{}}}
 @c pthread_setspecific @asucorrupt @ascuheap @acucorrupt @acsmem
 @c   a level2 block may be allocated by a signal handler after
@@ -92,9 +88,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})
+@standards{GNU, pthread.h}
 @safety{@prelim{}@mtsafe{}@asunsafe{@asulock{}}@acunsafe{@aculock{}}}
 @c Takes lock around read from default_pthread_attr.
 Get the default attribute values and set @var{attr} to match.  This
@@ -102,9 +97,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})
+@standards{GNU, pthread.h}
 @safety{@prelim{}@mtsafe{}@asunsafe{@ascuheap{} @asulock{}}@acunsafe{@aculock{} @acsmem{}}}
 @c pthread_setattr_default_np @ascuheap @asulock @aculock @acsmem
 @c  check_sched_policy_attr ok