Document that AS_INIT is automatically used.

* doc/autoconf.texi (Initialization Macros) <AS_INIT>: Add words
to clarify that only bare-bones scripts need a direct AS_INIT.
Suggested by Reuben Thomas.

Signed-off-by: Eric Blake <ebb9@byu.net>

diff --git a/ChangeLog b/ChangeLog
index 6e585f732d855a39d183100f8c7ef32a35b80962..9ea4ed66a75657883b7c0ac080470b581d402356 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2009-09-10  Eric Blake  <ebb9@byu.net>
 
+       Document that AS_INIT is automatically used.
+       * doc/autoconf.texi (Initialization Macros) <AS_INIT>: Add words
+       to clarify that only bare-bones scripts need a direct AS_INIT.
+       Suggested by Reuben Thomas.
+
        Clarify portability pitfall of test.
        * doc/autoconf.texi (Limitations of Builtins) <test>: Give more
        reasons why -a and -o are not portable.

diff --git a/doc/autoconf.texi b/doc/autoconf.texi
index a43c6142f14e664dcb37cd2312d5d0534f6d6a91..4203cd0f2319ed4e0db1de18eb57a3afa5bf2b81 100644 (file)
--- a/doc/autoconf.texi
+++ b/doc/autoconf.texi
@@ -12949,7 +12949,10 @@ generated from, and code to sanitize the environment for the rest of the
 script.  Among other initializations, this sets @env{SHELL} to the shell
 chosen to run the script (@pxref{CONFIG_SHELL}), and @env{LC_ALL} to
 ensure the C locale.  Finally, it changes the current diversion to
-@code{BODY}.
+@code{BODY}.  @code{AS_INIT} is called automatically by @code{AC_INIT}
+and @code{AT_INIT}, so shell code in @file{configure},
+@file{config.status}, and @file{testsuite} all benefit from a sanitized
+shell environment.
 @end defmac
 
 @defmac AS_INIT_GENERATED (@var{file}, @ovar{comment})