]> git.ipfire.org Git - thirdparty/autoconf.git/commitdiff
Recommend AS_HELP_STRING more prominently.
authorEric Blake <ebb9@byu.net>
Tue, 17 Mar 2009 12:05:11 +0000 (06:05 -0600)
committerEric Blake <ebb9@byu.net>
Tue, 17 Mar 2009 12:05:11 +0000 (06:05 -0600)
* doc/autoconf.texi (External Software): Reduce mention of
hand-written help strings.
Reported by Reuben Thomas.

Signed-off-by: Eric Blake <ebb9@byu.net>
ChangeLog
doc/autoconf.texi

index 78ac1946d35ef35ffda1e4749cebcfe9373a589e..94354572221a1311694a90be29e3073f3ac53f63 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2009-03-17  Eric Blake  <ebb9@byu.net>
+
+       Recommend AS_HELP_STRING more prominently.
+       * doc/autoconf.texi (External Software): Reduce mention of
+       hand-written help strings.
+       Reported by Reuben Thomas.
+
 2009-03-16  Eric Blake  <ebb9@byu.net>
 
        Fix 'make pdf'.
index 6109bb2ab0dda5d5814a83605dc1ae696e13d47c..fe852fe2c340aa9d08ca81a62f7c2cfd7813d895 100644 (file)
@@ -19328,11 +19328,8 @@ looks like this:
 @noindent
 @var{help-string} may be more than one line long, if more detail is
 needed.  Just make sure the columns line up in @samp{configure
---help}.  Avoid tabs in the help string.  You'll need to enclose the
-help string in @samp{[} and @samp{]} in order to produce the leading
-blanks.
-
-You should format your @var{help-string} with the macro
+--help}.  Avoid tabs in the help string.  The easiest way to provide the
+proper leading whitespace is to format your @var{help-string} with the macro
 @code{AS_HELP_STRING} (@pxref{Pretty Help Strings}).
 
 The following example shows how to use the @code{AC_ARG_WITH} macro in