Re: Conflicting information in manual

[Eric Blake]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

According to Reuben Thomas on 3/17/2009 5:57 AM:
> The following text occurs in the manual:
> 
>      Just make sure the columns line up in `configure --help'.
>      Avoid tabs in the help string.  You'll need to enclose the help
>      string in `[' and `]' in order to produce the leading blanks.
> 
>      You should format your HELP-STRING with the macro `AS_HELP_STRING'
>      (*note Pretty Help Strings::).
> 
> I suggest that the first paragraph (which is actually part of a
> paragraph) be deleted, as it is superceded by the second paragraph.

Thanks for the suggestion.  I'll be pushing this:

- --
Don't work too hard, make some time for fun as well!

Eric Blake             address@hidden
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Public key at home.comcast.net/~ericblake/eblake.gpg
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkm/kiMACgkQ84KuGfSFAYBErwCeMmxCkMBaTTk+o8BYVXuYwhfq
YrEAn2Z/j7PEQ98F+cblh/STW7C8B1TU
=wo8Z
-----END PGP SIGNATURE-----

>From 26a4c7275d690900c7c4b4ab9017e6fcce00f372 Mon Sep 17 00:00:00 2001
From: Eric Blake <address@hidden>
Date: Tue, 17 Mar 2009 06:05:11 -0600
Subject: [PATCH] Recommend AS_HELP_STRING more prominently.

* doc/autoconf.texi (External Software): Reduce mention of
hand-written help strings.
Reported by Reuben Thomas.

Signed-off-by: Eric Blake <address@hidden>
---
 ChangeLog         |    7 +++++++
 doc/autoconf.texi |    7 ++-----
 2 files changed, 9 insertions(+), 5 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 78ac194..9435457 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2009-03-17  Eric Blake  <address@hidden>
+
+       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  <address@hidden>

        Fix 'make pdf'.
diff --git a/doc/autoconf.texi b/doc/autoconf.texi
index 6109bb2..fe852fe 100644
--- a/doc/autoconf.texi
+++ b/doc/autoconf.texi
@@ -19328,11 +19328,8 @@ External Software
 @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
-- 
1.6.1.2