FYI: 02-doc-m4sugar.texi

[Akim Demaille]

Index: ChangeLog
from  Akim Demaille  <address@hidden>

        * doc/autoconf.texi (Redefined M4 Macros): Document m4_exit,
        m4_if, and m4_wrap.
                
Index: doc/autoconf.texi
--- doc/autoconf.texi Wed, 01 Aug 2001 23:34:52 +0200 akim (ace/16_autoconf.t 
1.61.2.112.1.8 644)
+++ doc/autoconf.texi Thu, 02 Aug 2001 01:04:26 +0200 akim (ace/16_autoconf.t 
1.61.2.112.1.8 644)
@@ -6430,13 +6430,17 @@ @node Programming in M4sugar,  , M4 Quot
 @node Redefined M4 Macros, Forbidden Patterns, Programming in M4sugar, 
Programming in M4sugar
 @subsection Redefined M4 Macros
 
-All the M4 native macros are moved in the @samp{m4_} pseudo-namespace,
-e.g., M4sugar renames @code{define} as @code{m4_define} etc.  There is
-one exception: @code{dnl} kept its original name, and no @code{m4_dnl}
-is defined.
-
-M4sugar redefines some M4 macros, and made them slightly incompatible
-with their native equivalent.
+With a few exceptions, all the M4 native macros are moved in the
address@hidden pseudo-namespace, e.g., M4sugar renames @code{define} as
address@hidden etc.
+
+Some M4 macros are redefined, and are slightly incompatible with their
+native equivalent.
+
address@hidden dnl
address@hidden dnl
+This macro kept its original name: no @code{m4_dnl} is defined.
address@hidden defmac
 
 @defmac m4_defn (@var{macro})
 @msindex defn
@@ -6444,6 +6448,18 @@ @node Redefined M4 Macros, Forbidden Pat
 defined.  See @code{m4_undefine}.
 @end defmac
 
address@hidden m4_exit (@var{exit-status})
address@hidden m4_exit
+This macro corresponds to @code{m4exit}.
address@hidden defmac
+
address@hidden m4_if (@var{comment})
address@hidden m4_if (@var{string-1}, @var{string-2}, @var{equal}, 
@ovar{not-equal})
address@hidden m4_if (@var{string-1}, @var{string-2}, @var{equal}, ...)
address@hidden m4_if
+This macro corresponds to @code{ifelse}.
address@hidden defmac
+
 @defmac m4_undefine (@var{macro})
 @msindex undefine
 Contrary to the M4 builtin, this macro fails if @var{macro} is not
@@ -6461,6 +6477,24 @@ @node Redefined M4 Macros, Forbidden Pat
 @msindex defn
 Contrary to the M4 builtin, this macro fails if @var{macro} is not
 defined.  See @code{m4_undefine}.
address@hidden defmac
+
address@hidden m4_wrap (@var{text})
address@hidden m4_wrap
+This macro corresponds to @code{m4wrap}.
+
+You are encouraged to end @var{text} with @samp{[]}, so that there are
+no risks that two consecutive invocations of @code{m4_wrap} result in an
+unexpected pasting of tokens, as in
+
address@hidden
+m4_define([foo], [Foo])
+m4_define([bar], [Bar])
+m4_define([foobar], [FOOBAR])
+m4_wrap([bar])
+m4_wrap([foo])
address@hidden
address@hidden example
 @end defmac
 
 @node Forbidden Patterns,  , Redefined M4 Macros, Programming in M4sugar