From patchwork Mon Feb 19 11:42:53 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rical Jasan X-Patchwork-Id: 25962 Received: (qmail 101151 invoked by alias); 19 Feb 2018 11:43:04 -0000 Mailing-List: contact libc-alpha-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: libc-alpha-owner@sourceware.org Delivered-To: mailing list libc-alpha@sourceware.org Received: (qmail 101094 invoked by uid 89); 19 Feb 2018 11:43:03 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-25.3 required=5.0 tests=AWL, BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, SPF_PASS, T_RP_MATCHES_RCVD autolearn=ham version=3.3.2 spammy=1993, SUS, Refer, brand X-HELO: smtp.pacific.net From: Rical Jasan To: libc-alpha Cc: Joseph Myers , Michael Kerrisk , Zack Weinberg , Carlos O'Donell Subject: [PATCH v3] manual: Document missing feature test macros. Date: Mon, 19 Feb 2018 03:42:53 -0800 Message-Id: <20180219114253.25420-1-ricaljasan@pacific.net> In-Reply-To: <20170728034305.13389-1-ricaljasan@pacific.net> References: <20170728034305.13389-1-ricaljasan@pacific.net> Several feature test macros are documented in features.h but absent in the manual, and some documented macros accept undocumented values. This commit updates the manual to mention all the accepted macros, along with any values that hold special meaning. * manual/creature.texi (_POSIX_C_SOURCE): Document special values of 199606L, 200112L, and 200809L. (_XOPEN_SOURCE): Document special values of 600 and 700. (_ISOC11_SOURCE): Document macro. (_ATFILE_SOURCE): Likewise. (_FORTIFY_SOURCE): Likewise. --- Changes in v3: * Mention in general that bug-fixes to POSIX standards are included with the base version. * Reference SUS versions. Changes in v2: * Refer to base editions of POSIX standards, and mention supported subsequent bug-fix editions explicitly. * Set @standards for _ATFILE_SOURCE and _FORTIFY_SOURCE to GNU. * Minor wording changes * Rebase to master (post-88f9e739). --- manual/creature.texi | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/manual/creature.texi b/manual/creature.texi index 2e05958756..483bf85ad7 100644 --- a/manual/creature.texi +++ b/manual/creature.texi @@ -61,13 +61,27 @@ If you define this macro to a value greater than or equal to @code{199309L}, then the functionality from the 1993 edition of the POSIX.1b standard (IEEE Standard 1003.1b-1993) is made available. +If you define this macro to a value greater than or equal to +@code{199506L}, then the functionality from the 1995 edition of the +POSIX.1c standard (IEEE Standard 1003.1c-1995) is made available. + +If you define this macro to a value greater than or equal to +@code{200112L}, then the functionality from the 2001 edition of the +POSIX standard (IEEE Standard 1003.1-2001) is made available. + +If you define this macro to a value greater than or equal to +@code{200809L}, then the functionality from the 2008 edition of the +POSIX standard (IEEE Standard 1003.1-2008) is made available. + Greater values for @code{_POSIX_C_SOURCE} will enable future extensions. The POSIX standards process will define these values as necessary, and @theglibc{} should support them some time after they become standardized. The 1996 edition of POSIX.1 (ISO/IEC 9945-1: 1996) states that if you define @code{_POSIX_C_SOURCE} to a value greater than or equal to @code{199506L}, then the functionality from the 1996 -edition is made available. +edition is made available. In general, in @theglibc{}, bugfixes to +the standards are included when specifying the base version; e.g., +POSIX.1-2004 will always be included with a value of @code{200112L}. @end defvr @defvr Macro _XOPEN_SOURCE @@ -87,7 +101,10 @@ available which are necessary for the X/Open Unix brand. If the macro @code{_XOPEN_SOURCE} has the value @math{500} this includes all functionality described so far plus some new definitions from the -Single Unix Specification, @w{version 2}. +Single Unix Specification, @w{version 2}. The value @math{600} +(corresponding to the sixth revision) includes definitions from SUSv3, +and using @math{700} (the seventh revision) includes definitions from +SUSv4. @end defvr @defvr Macro _LARGEFILE_SOURCE @@ -156,6 +173,11 @@ implementation of the new standard and to enable the new features the macro @code{_ISOC99_SOURCE} should be defined. @end defvr +@defvr Macro _ISOC11_SOURCE +@standards{C11, (none)} +If this macro is defined, ISO C11 extensions to ISO C99 are included. +@end defvr + @defvr Macro __STDC_WANT_LIB_EXT2__ @standards{ISO, (none)} If you define this macro to the value @code{1}, features from ISO/IEC @@ -209,6 +231,19 @@ enables those features even when the other options would otherwise cause them to be disabled. @end defvr +@defvr Macro _ATFILE_SOURCE +@standards{GNU, (none)} +If this macro is defined, additional @code{*at} interfaces are +included. +@end defvr + +@defvr Macro _FORTIFY_SOURCE +@standards{GNU, (none)} +If this macro is defined to @math{1}, security hardening is added to +various library functions. If defined to @math{2}, even stricter +checks are applied. +@end defvr + @defvr Macro _REENTRANT @defvrx Macro _THREAD_SAFE @standards{Obsolete, (none)}