From: Eric Blake Date: Tue, 17 Mar 2009 12:05:11 +0000 (-0600) Subject: Recommend AS_HELP_STRING more prominently. X-Git-Tag: v2.63b~11 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=26a4c7275d690900c7c4b4ab9017e6fcce00f372;p=thirdparty%2Fautoconf.git 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 --- diff --git a/ChangeLog b/ChangeLog index 78ac1946d..943545722 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2009-03-17 Eric Blake + + 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 Fix 'make pdf'. diff --git a/doc/autoconf.texi b/doc/autoconf.texi index 6109bb2ab..fe852fe2c 100644 --- a/doc/autoconf.texi +++ b/doc/autoconf.texi @@ -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