FYI: M4 macro documentation (was Re: gcc -Wall warning for minmax.h)

[Derek Price]

Derek Price wrote:

>Would anyone mind if I committed a patch with @msindex entries for the
>37 or so undocumented m4_* macros in the `Redefined M4 Macros' node of
>doc/autoconf.texi?  I'm not bothering to include the patch in this email
>because it is too simple but I don't want to waste the 15 minutes it
>will take to write it without approval.  :)
>  
>

No one responded for a few days, so I checked in the attached patch.  It
documents all the macros renamed from M4 except: changecom, changequote,
changeword, debugfile, debugmode, divert, divnum, traceoff, traceon, &
undivert.  I thought use of those macros by users was either very likely
to interfere with normal autoconf operation or there is an alternative
API to them on the AC command line, or both.

2005-06-08  Derek Price  <address@hidden>

        * doc/autoconf.texi (Redefined M4 Macros): Add index entries for
most
        redefined M4 macros to this node.  Document m4_include &
m4_sinclude.
        Move m4_undefine to alphabetical order.

Cheers,

Derek

Index: ChangeLog
===================================================================
RCS file: /cvsroot/autoconf/autoconf/ChangeLog,v
retrieving revision 1.2553
diff -u -p -r1.2553 ChangeLog
--- ChangeLog   8 Jun 2005 07:55:28 -0000       1.2553
+++ ChangeLog   8 Jun 2005 15:40:40 -0000
@@ -1,3 +1,9 @@
+2005-06-08  Derek Price  <address@hidden>
+
+       * doc/autoconf.texi (Redefined M4 Macros): Add index entries for most
+       redefined M4 macros to this node.  Document m4_include & m4_sinclude.
+       Move m4_undefine to alphabetical order.
+
 2005-06-07  Paul Eggert  <address@hidden>
 
        * README: Recommend GNU M4 1.4.3 or later.
Index: doc/autoconf.texi
===================================================================
RCS file: /cvsroot/autoconf/autoconf/doc/autoconf.texi,v
retrieving revision 1.908
diff -u -p -r1.908 autoconf.texi
--- doc/autoconf.texi   8 Jun 2005 07:55:29 -0000       1.908
+++ doc/autoconf.texi   8 Jun 2005 15:40:45 -0000
@@ -8726,6 +8726,27 @@ M4sugar''.
 @node Redefined M4 Macros
 @subsection Redefined M4 Macros
 
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
address@hidden
 With a few exceptions, all the M4 native macros are moved in the
 @samp{m4_} pseudo-namespace, e.g., M4sugar renames @code{define} as
 @code{m4_define} etc.
@@ -8756,17 +8777,11 @@ This macro corresponds to @code{m4exit}.
 This macro corresponds to @code{ifelse}.
 @end defmac
 
address@hidden m4_undefine (@var{macro})
address@hidden
-Contrary to the M4 builtin, this macro fails if @var{macro} is not
-defined.  Use
-
address@hidden
-m4_ifdef(address@hidden, [m4_undefine(address@hidden)])
address@hidden example
-
address@hidden
-to recover the behavior of the builtin.
address@hidden m4_include (@var{file})
address@hidden m4_sinclude (@var{file})
address@hidden
address@hidden
+Like the M4 builtins, but warn against multiple inclusions of @var{file}.
 @end defmac
 
 @defmac m4_bpatsubst (@var{string}, @var{regexp}, @ovar{replacement})
@@ -8807,6 +8822,19 @@ m4_wrap([foo])
 @end example
 @end defmac
 
address@hidden m4_undefine (@var{macro})
address@hidden
+Contrary to the M4 builtin, this macro fails if @var{macro} is not
+defined.  Use
+
address@hidden
+m4_ifdef(address@hidden, [m4_undefine(address@hidden)])
address@hidden example
+
address@hidden
+to recover the behavior of the builtin.
address@hidden defmac
+
 @node Evaluation Macros
 @subsection Evaluation Macros