From: Stepan Kasal <kasal@ucw.cz>
Date: Fri, 13 Oct 2006 18:26:38 +0000 (+0000)
Subject: * doc/autoconf.texi (Autoheader Macros): Warn that the text
X-Git-Tag: AUTOCONF-2.60b~11
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9ae405343e3109d1ef7b0a666b3e6a48d339727d;p=thirdparty%2Fautoconf.git

* doc/autoconf.texi (Autoheader Macros): Warn that the text
added to the template can get mangled.
---

diff --git a/ChangeLog b/ChangeLog
index 474f92dbc..8192f7226 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2006-10-13  Stepan Kasal  <kasal@ucw.cz>
+
+	* doc/autoconf.texi (Autoheader Macros): Warn that the text
+	added to the template can get mangled.
+
 2006-10-13  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>
 
 	* lib/autoconf/functions.m4 (AC_FUNC_OBSTACK): In the test,
diff --git a/doc/autoconf.texi b/doc/autoconf.texi
index 464eb0a34..a62b7178f 100644
--- a/doc/autoconf.texi
+++ b/doc/autoconf.texi
@@ -3137,27 +3137,12 @@ templates for symbols defined by @code{AC_CHECK_HEADERS},
 symbol, you must define a template for it.  If there are missing
 templates, @command{autoheader} fails with an error message.
 
-The simplest way to create a template for a @var{symbol} is to supply
-the @var{description} argument to an @samp{AC_DEFINE(@var{symbol})}; see
-@ref{Defining Symbols}.  You may also use one of the following macros.
+The template for a @var{symbol} is created
+by @command{autoheader} from
+the @var{description} argument to an @code{AC_DEFINE};
+see @ref{Defining Symbols}.
 
-@defmac AH_VERBATIM (@var{key}, @var{template})
-@ahindex{VERBATIM}
-Tell @command{autoheader} to include the @var{template} as-is in the header
-template file.  This @var{template} is associated with the @var{key},
-which is used to sort all the different templates and guarantee their
-uniqueness.  It should be a symbol that can be defined via @code{AC_DEFINE}.
-
-For example:
-
-@example
-AH_VERBATIM([_GNU_SOURCE],
-[/* Enable GNU extensions on systems that have them.  */
-#ifndef _GNU_SOURCE
-# define _GNU_SOURCE
-#endif])
-@end example
-@end defmac
+For special needs, you can use the following macros.
 
 
 @defmac AH_TEMPLATE (@var{key}, @var{description})
@@ -3189,6 +3174,14 @@ justified.
 @end defmac
 
 
+@defmac AH_VERBATIM (@var{key}, @var{template})
+@ahindex{VERBATIM}
+Tell @command{autoheader} to include the @var{template} as-is in the header
+template file.  This @var{template} is associated with the @var{key},
+which is used to sort all the different templates and guarantee their
+uniqueness.  It should be a symbol that can be defined via @code{AC_DEFINE}.
+
+
 @defmac AH_TOP (@var{text})
 @ahindex{TOP}
 Include @var{text} at the top of the header template file.
@@ -3201,6 +3194,16 @@ Include @var{text} at the bottom of the header template file.
 @end defmac
 
 
+Please note that @var{text} gets included ``verbatim'' to the template file,
+not to the resulting config header, so it can easily get mangled when the
+template is processed.  There is rarely a need for something other than
+
+@example
+AH_BOTTOM([#include <custom.h>])
+@end example
+
+
+
 @node Configuration Commands
 @section Running Arbitrary Configuration Commands
 @cindex Configuration commands