From 0223b0407c586414a42d64e66a3045322bae29b5 Mon Sep 17 00:00:00 2001
From: "Matthew D. Langston" <[EMAIL REDACTED]>
Date: Wed, 9 Jun 1999 21:10:01 +0000
Subject: [PATCH] Synchronize documentation with implementation.
---
ChangeLog | 5 +++++
autoconf.texi | 13 +++----------
doc/autoconf.texi | 13 +++----------
3 files changed, 11 insertions(+), 20 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index f22bd5c8..677a5726 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+1999-06-09 Matthew D. Langston <langston@SLAC.Stanford.EDU>
+
+ * autoconf.texi (Pretty Help Strings): Synchronize documentation
+ with implementation.
+
1999-06-04 Matthew D. Langston <langston@SLAC.Stanford.EDU>
* acgeneral.m4 (AC_OUTPUT_MAKE_DEFS): Fix sed regexp for handling
diff --git a/autoconf.texi b/autoconf.texi
index a4821fea..0b83168a 100644
--- a/autoconf.texi
+++ b/autoconf.texi
@@ -4663,10 +4663,9 @@ support providing a help string.
Properly formatting the @samp{help strings} which are used in
@code{AC_ARG_WITH} (@pxref{External Software}) and @code{AC_ARG_ENABLE}
(@pxref{Package Options}) can be challenging. Specifically, you want
-your own @samp{help strings}, especially multi-line help strings, to
-wrap and line up in the appropriate columns of @samp{configure --help}
-just like the standard Autoconf @samp{help strings} do. This is the
-purpose of the @code{AC_HELP_STRING} macro.
+your own @samp{help strings} to line up in the appropriate columns of
+@samp{configure --help} just like the standard Autoconf @samp{help
+strings} do. This is the purpose of the @code{AC_HELP_STRING} macro.
@defmac AC_HELP_STRING (@var{left-hand-side}, @var{right-hand-side}, @var{formatted-help-string})
@maindex HELP_STRING
@@ -4720,12 +4719,6 @@ AC_DEFUN(MY_ARG_WITH,
AC_CACHE_CHECK(whether to use $1, ac_cv_use_$1, ac_cv_use_$1=$2)
])
@end example
-
-Make your help strings as long as you wish, as @code{AC_HELP_STRING}
-will properly wrap them. However, shorter, more succinct help strings
-are usually easier for the user running @samp{configure --help}, and
-they look better too.
-
@end defmac
diff --git a/doc/autoconf.texi b/doc/autoconf.texi
index a4821fea..0b83168a 100644
--- a/doc/autoconf.texi
+++ b/doc/autoconf.texi
@@ -4663,10 +4663,9 @@ support providing a help string.
Properly formatting the @samp{help strings} which are used in
@code{AC_ARG_WITH} (@pxref{External Software}) and @code{AC_ARG_ENABLE}
(@pxref{Package Options}) can be challenging. Specifically, you want
-your own @samp{help strings}, especially multi-line help strings, to
-wrap and line up in the appropriate columns of @samp{configure --help}
-just like the standard Autoconf @samp{help strings} do. This is the
-purpose of the @code{AC_HELP_STRING} macro.
+your own @samp{help strings} to line up in the appropriate columns of
+@samp{configure --help} just like the standard Autoconf @samp{help
+strings} do. This is the purpose of the @code{AC_HELP_STRING} macro.
@defmac AC_HELP_STRING (@var{left-hand-side}, @var{right-hand-side}, @var{formatted-help-string})
@maindex HELP_STRING
@@ -4720,12 +4719,6 @@ AC_DEFUN(MY_ARG_WITH,
AC_CACHE_CHECK(whether to use $1, ac_cv_use_$1, ac_cv_use_$1=$2)
])
@end example
-
-Make your help strings as long as you wish, as @code{AC_HELP_STRING}
-will properly wrap them. However, shorter, more succinct help strings
-are usually easier for the user running @samp{configure --help}, and
-they look better too.
-
@end defmac