about summary refs log tree commit diff
path: root/manual/creature.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/creature.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/creature.texi')
-rw-r--r--manual/creature.texi44
1 files changed, 14 insertions, 30 deletions
diff --git a/manual/creature.texi b/manual/creature.texi
index 23218bbac3..eb30b0118d 100644
--- a/manual/creature.texi
+++ b/manual/creature.texi
@@ -33,9 +33,8 @@ standard.  It is insufficient for this purpose, as it will not protect you
 from including header files outside the standard, or relying on semantics
 undefined within the standard.
 
-@comment (none)
-@comment POSIX.1
 @defvr Macro _POSIX_SOURCE
+@standards{POSIX.1, (none)}
 If you define this macro, then the functionality from the POSIX.1
 standard (IEEE Standard 1003.1) is available, as well as all of the
 @w{ISO C} facilities.
@@ -44,9 +43,8 @@ The state of @code{_POSIX_SOURCE} is irrelevant if you define the
 macro @code{_POSIX_C_SOURCE} to a positive integer.
 @end defvr
 
-@comment (none)
-@comment POSIX.2
 @defvr Macro _POSIX_C_SOURCE
+@standards{POSIX.2, (none)}
 Define this macro to a positive integer to control which POSIX
 functionality is made available.  The greater the value of this macro,
 the more functionality is made available.
@@ -72,12 +70,9 @@ or equal to @code{199506L}, then the functionality from the 1996
 edition is made available.
 @end defvr
 
-@comment (none)
-@comment X/Open
 @defvr Macro _XOPEN_SOURCE
-@comment (none)
-@comment X/Open
 @defvrx Macro _XOPEN_SOURCE_EXTENDED
+@standards{X/Open, (none)}
 If you define this macro, functionality described in the X/Open
 Portability Guide is included.  This is a superset of the POSIX.1 and
 POSIX.2 functionality and in fact @code{_POSIX_SOURCE} and
@@ -95,9 +90,8 @@ all functionality described so far plus some new definitions from the
 Single Unix Specification, @w{version 2}.
 @end defvr
 
-@comment (NONE)
-@comment X/Open
 @defvr Macro _LARGEFILE_SOURCE
+@standards{X/Open, (NONE)}
 If this macro is defined some extra functions are available which
 rectify a few shortcomings in all previous standards.  Specifically,
 the functions @code{fseeko} and @code{ftello} are available.  Without
@@ -108,9 +102,8 @@ these functions the difference between the @w{ISO C} interface
 This macro was introduced as part of the Large File Support extension (LFS).
 @end defvr
 
-@comment (NONE)
-@comment X/Open
 @defvr Macro _LARGEFILE64_SOURCE
+@standards{X/Open, (NONE)}
 If you define this macro an additional set of functions is made available
 which enables @w{32 bit} systems to use files of sizes beyond
 the usual limit of 2GB.  This interface is not available if the system
@@ -128,9 +121,8 @@ This macro was introduced as part of the Large File Support extension
 offsets are not generally used (see @code{_FILE_OFFSET_BITS}).
 @end defvr
 
-@comment (NONE)
-@comment X/Open
 @defvr Macro _FILE_OFFSET_BITS
+@standards{X/Open, (NONE)}
 This macro determines which file system interface shall be used, one
 replacing the other.  Whereas @code{_LARGEFILE64_SOURCE} makes the @w{64
 bit} interface available as an additional interface,
@@ -156,62 +148,55 @@ This macro was introduced as part of the Large File Support extension
 (LFS).
 @end defvr
 
-@comment (none)
-@comment GNU
 @defvr Macro _ISOC99_SOURCE
+@standards{GNU, (none)}
 Until the revised @w{ISO C} standard is widely adopted the new features
 are not automatically enabled.  @Theglibc{} nevertheless has a complete
 implementation of the new standard and to enable the new features the
 macro @code{_ISOC99_SOURCE} should be defined.
 @end defvr
 
-@comment (none)
-@comment ISO
 @defvr Macro __STDC_WANT_LIB_EXT2__
+@standards{ISO, (none)}
 If you define this macro to the value @code{1}, features from ISO/IEC
 TR 24731-2:2010 (Dynamic Allocation Functions) are enabled.  Only some
 of the features from this TR are supported by @theglibc{}.
 @end defvr
 
-@comment (none)
-@comment ISO
 @defvr Macro __STDC_WANT_IEC_60559_BFP_EXT__
+@standards{ISO, (none)}
 If you define this macro, features from ISO/IEC TS 18661-1:2014
 (Floating-point extensions for C: Binary floating-point arithmetic)
 are enabled.  Only some of the features from this TS are supported by
 @theglibc{}.
 @end defvr
 
-@comment (none)
-@comment ISO
 @defvr Macro __STDC_WANT_IEC_60559_FUNCS_EXT__
+@standards{ISO, (none)}
 If you define this macro, features from ISO/IEC TS 18661-4:2015
 (Floating-point extensions for C: Supplementary functions) are
 enabled.  Only some of the features from this TS are supported by
 @theglibc{}.
 @end defvr
 
-@comment (none)
-@comment ISO
 @defvr Macro __STDC_WANT_IEC_60559_TYPES_EXT__
+@standards{ISO, (none)}
 If you define this macro, features from ISO/IEC TS 18661-3:2015
 (Floating-point extensions for C: Interchange and extended types) are
 enabled.  Only some of the features from this TS are supported by
 @theglibc{}.
 @end defvr
 
-@comment (none)
-@comment GNU
 @defvr Macro _GNU_SOURCE
+@standards{GNU, (none)}
 If you define this macro, everything is included: @w{ISO C89}, @w{ISO
 C99}, POSIX.1, POSIX.2, BSD, SVID, X/Open, LFS, and GNU extensions.  In
 the cases where POSIX.1 conflicts with BSD, the POSIX definitions take
 precedence.
 @end defvr
 
-@comment (none)
-@comment GNU
 @defvr Macro _DEFAULT_SOURCE
+@standards{GNU, (none)}
 If you define this macro, most features are included apart from
 X/Open, LFS and GNU extensions: the effect is to enable features from
 the 2008 edition of POSIX, as well as certain BSD and SVID features
@@ -224,10 +209,9 @@ enables those features even when the other options would otherwise
 cause them to be disabled.
 @end defvr
 
-@comment (none)
-@comment GNU
 @defvr Macro _REENTRANT
 @defvrx Macro _THREAD_SAFE
+@standardsx{_REENTRANT, GNU, (none)}
 These macros are obsolete.  They have the same effect as defining
 @code{_POSIX_C_SOURCE} with the value @code{199506L}.