Re: document AS_SHELL_SANITIZE and AS_BOURNE_COMPATIBLE

[Paul Eggert]

Ralf Wildenhues <address@hidden> writes:

>         * lib/m4sugar/m4sh.m4 (_AS_BOURNE_COMPATIBLE): Renamed to..
>         (AS_BOURNE_COMPATIBLE): ..this.
>         (_AS_RUN, AS_SHELL_SANITIZE): Adjusted all callers.
>         * doc/autoconf.texi (Programming in M4sh): Document
>         AS_BOURNE_COMPATIBLE and AS_SHELL_SANITIZE.

Thanks.  I installed that, with the following I-hope-improved version
of the doc patch:

--- autoconf.texi.~1.945~       2006-02-13 10:34:50.000000000 -0800
+++ autoconf.texi       2006-02-13 10:43:27.000000000 -0800
@@ -8992,6 +8992,14 @@ For the time being, it is not mature eno
 M4sh provides portable alternatives for some common shell constructs
 that unfortunately are not portable in practice.
 
address@hidden AS_BOURNE_COMPATIBLE
address@hidden
+Set up the shell to be more compatible with the Bourne shell as
+standardized by Posix, if possible.  This may involve setting
+environment variables, or setting options, or similar
+implementation-specific actions.
address@hidden defmac
+
 @defmac AS_DIRNAME (@var{file-name})
 @asindex{DIRNAME}
 Return the directory portion of @var{file-name}, using the algorithm
@@ -9018,6 +9026,15 @@ even though Posix is unclear whether @sa
 succeed in that case.
 @end defmac
 
address@hidden AS_SHELL_SANITIZE
address@hidden
+Initialize the shell suitably for @code{configure} scripts.  This has
+the effect of @code{AS_BOURNE_COMPATIBLE}, and sets some other
+environment variables for predictable results from configuration tests.
+For example, it sets @env{LC_ALL} to change to the default C locale.
address@hidden Shell Variables}.
address@hidden defmac
+
 @defmac AS_TR_CPP (@var{expression})
 @asindex{TR_CPP}
 Transform @var{expression} into a valid right-hand side for a C @code{#define}.