+2002-04-21 Paul Eggert <eggert@twinsun.com>
+
+ * TODO, bin/autoupdate.in, doc/autoconf.texi,
+ lib/autoconf/general.m4, lib/autoconf/libs.m4,
+ lib/autoconf/status.m4, lib/m4sugar/m4sugar.m4, tests/m4sh.at,
+ tests/tools.at: Minor spelling and grammar fixes.
+
2002-04-20 Paul Eggert <eggert@twinsun.com>
* doc/autoconf.texi (Shell Substitutions): Fix typos in yesterday's
decisions, and progress messages, should be recorded on the terminal
only if --verbose is used.
- --silent just supresses the "checking for...result"
+ --silent just suppresses the "checking for...result"
messages, not the "creating FOO" messages.
I think the default should be to suppress both.
------------------------------------------------------------------------------
Another thing I wish for is a macro which figures out which libraries are
-needed for BSD-sytle sockets. AC_PATH_X already detects this
-correctly...so it's just a matter of seperating out the socket-related code.
+needed for BSD-style sockets. AC_PATH_X already detects this
+correctly...so it's just a matter of separating out the socket-related code.
From: "Joel N. Weber II" <nemo@koa.iolani.honolulu.hi.us>
------------------------------------------------------------------------------
# 0)
#
# In French, we say `Youpi !', which you might roughly translate as
-# `yipeee!'.
+# `Yippee!'.
#
#
# # First step: computation
# Worse yet, if `idem(0)' was used later, then autoupdate sees that
# `OLD' is used, computes the result for `OLD(0, 0)' and sets up a
# dispatcher for `OLD'. Since there was no computed value for `OLD(0,
-# [$1])', the dispatcher would have replaced with... nothinhg, leading
+# [$1])', the dispatcher would have replaced with... nothing, leading
# to
#
# define([idem], [])
#
# Well... almost.
#
-# There is a slight problem that remains: if an AU macro OUTTER includes
-# an AU macro INNER, then _au_enable will be run when entering OUTTER
+# There is a slight problem that remains: if an AU macro OUTER includes
+# an AU macro INNER, then _au_enable will be run when entering OUTER
# and when entering INNER (not good, but not too bad yet). But when
# getting out of INNER, _au_disable will disable everything while we
-# were still in OUTTER. Badaboom.
+# were still in OUTER. Badaboom.
#
# Therefore _au_enable and _au_disable have to be written to work by
# pairs: each _au_enable pushdef's _au_enabled, and each _au_disable
@end example
@noindent
-But, while it is acceptable for a @file{configure.ac} to avoid unneeded
+But, while it is acceptable for a @file{configure.ac} to avoid unnecessary
quotes, it is bad practice for Autoconf macros which must both be more
robust and also advocate perfect style.
-At the top level, there are only two possible quotings: either you
+At the top level, there are only two possibilities: either you
quote or you don't:
@example
@example
@group
AC_DEFUN([TRAVOLTA],
-[test "$body_temparature_in_celsius" -gt "38" &&
+[test "$body_temperature_in_celsius" -gt "38" &&
dance_floor=occupied])
AC_DEFUN([NEWTON_JOHN],
[test "$hair_style" = "curly" &&
Otherwise, the closing bracket would be hidden inside a @samp{#}-comment,
breaking the bracket-matching highlighting from Emacsen. Note the
preferred style to escape from M4: @samp{$[1]}, @samp{$[@@]}, etc. Do
-not escape when it is unneeded. Common examples of useless quotation
+not escape when it is unnecessary. Common examples of useless quotation
are @samp{[$]$1} (write @samp{$$1}), @samp{[$]var} (use @samp{$var}),
etc. If you add portability issues to the picture, you'll prefer
@samp{$@{1+"$[@@]"@}} to @samp{"[$]@@"}, and you'll prefer do something
in assignments though: @samp{foo=`cd /zorglub` 2>/dev/null}.
Most shells, if not all (including Bash, Zsh, Ash), output traces on
-stderr, even for sub-shells. This might result in undesired content
+stderr, even for sub-shells. This might result in undesirable content
if you meant to capture the standard-error output of the inner command:
@example
m4_divert_pop([HELP_BEGIN])dnl
dnl The order of the diversions here is
dnl - HELP_BEGIN
-dnl which may be prolongated by extra generic options such as with X or
+dnl which may be extended by extra generic options such as with X or
dnl AC_ARG_PROGRAM. Displayed only in long --help.
dnl
dnl - HELP_CANON
# config.status only pays attention to the cache file if you give it
# the --recheck option to rerun configure.
#
-# `ac_cv_env_foo' variables (set or unset) will be overriden when
+# `ac_cv_env_foo' variables (set or unset) will be overridden when
# loading this file, other *unset* `ac_cv_foo' will be assigned the
# following values.
# _AC_LIBOBJ(FILENAME-NOEXT, ACTION-IF-INDIR)
# -------------------------------------------
# We need `FILENAME-NOEXT.o', save this into `LIBOBJS'.
-# We don't use AC_SUBST/2 because it forces an unneeded eol.
+# We don't use AC_SUBST/2 because it forces an unnecessary eol.
m4_define([_AC_LIBOBJ],
[AS_LITERAL_IF([$1],
[AC_LIBSOURCE([$1.c])],
# AC_LIBOBJ(FILENAME-NOEXT)
# -------------------------
# We need `FILENAME-NOEXT.o', save this into `LIBOBJS'.
-# We don't use AC_SUBST/2 because it forces an unneeded eol.
+# We don't use AC_SUBST/2 because it forces an unnecessary eol.
m4_define([AC_LIBOBJ],
[_AC_LIBOBJ([$1],
[AC_DIAGNOSE(syntax,
# ac_cv_lib_$lib_fun, which is definitely not what was meant. Hence
# the AS_LITERAL_IF indirection.
#
-# FIXME: This macro is extremely suspicious. It DEFINEs unconditionnally,
+# FIXME: This macro is extremely suspicious. It DEFINEs unconditionally,
# whatever the FUNCTION, in addition to not being a *S macro. Note
# that the cache does depend upon the function we are looking for.
#
# socket/setsockopt and other routines are undefined under SCO ODT
# 2.0. But -lsocket is broken on IRIX 5.2 (and is not necessary
# on later versions), says Simon Leinen: it contains gethostby*
- # variants that don't use the nameserver (or something). -lsocket
+ # variants that don't use the name server (or something). -lsocket
# must be given before -lnsl if both are needed. We assume that
# if connect needs -lnsl, so does gethostbyname.
AC_CHECK_FUNC(connect)
-## ---------------------------------- ##
-## Ensuring the unicity of the tags. ##
-## ---------------------------------- ##
+## ------------------------------------- ##
+## Ensuring the uniqueness of the tags. ##
+## ------------------------------------- ##
# AC_CONFIG_IF_MEMBER(DEST, LIST-NAME, ACTION-IF-TRUE, ACTION-IF-FALSE)
# ----------------------------------------------------------------
-## ------------------------- ##
-## Outputing config.status. ##
-## ------------------------- ##
+## -------------------------- ##
+## Outputting config.status. ##
+## -------------------------- ##
# autoupdate::AC_OUTPUT([CONFIG_FILES...], [EXTRA-CMDS], [INIT-CMDS])
# ------------------
# This macro invokes all its arguments (in sequence, of course). It is
# useful for making your macros more structured and readable by dropping
-# unecessary dnl's and have the macros indented properly.
+# unnecessary dnl's and have the macros indented properly.
m4_define([m4_do],
[m4_if($#, 0, [],
$#, 1, [$1],
# Implementing `foreach' loops in m4 is much more tricky than it may
# seem. Actually, the example of a `foreach' loop in the m4
# documentation is wrong: it does not quote the arguments properly,
-# which leads to undesired expansions.
+# which leads to undesirable expansions.
#
# The example in the documentation is:
#
# of brackets around $1 (don't forget that the result must be quoted
# too, hence one more quoting than applications).
#
-# Then notice the 2 last pattens: they are in charge of removing the
+# Then notice the 2 last patterns: they are in charge of removing the
# leading/trailing spaces. Why not just `[^ ]'? Because they are
# applied to doubly quoted strings, i.e. more or less [[STRING]]. So
# if there is a leading space in STRING, then it is the *third*
])# AT_DATA_LINENO
# `_oline_', once processed and ran, produces our reference.
-# We check that we find ourself by looking at a string which is
+# We check that we find ourselves by looking at a string which is
# available only in the original script: `_oline_'.
AT_DATA_LINENO([reference.as], [false], [__@&t@oline__], [_oline__])
AT_CHECK([autom4te -l m4sh reference.as -o reference])
# A script that never returns. We don't care that it never returns,
# broken /bin/sh loop equally with `false', but it makes it easier to
-# test the robusteness in a good environment: just remove the `-n'.
+# test the robustness in a good environment: just remove the `-n'.
AT_DATA([endless.sh],
[[while :
do