+2010-03-12 Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
+
+ Formatting cleanups in macro comments.
+ * lib/autoconf/c.m4, lib/autoconf/erlang.m4,
+ lib/autoconf/fortran.m4, lib/autoconf/functions.m4,
+ lib/autoconf/general.m4, lib/autoconf/lang.m4,
+ lib/autoconf/programs.m4, lib/autoconf/specific.m4,
+ lib/autoconf/status.m4, lib/autoconf/types.m4,
+ lib/autotest/general.m4, lib/autotest/specific.m4,
+ lib/m4sugar/m4sh.m4, lib/m4sugar/m4sugar.m4,
+ tests/autotest.at, tests/local.at, tests/m4sh.at,
+ tests/semantics.at, tests/tools.at, tests/torture.at: Fix macro
+ comment format.
+
2010-03-05 Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
manual: index strings containing colon in non-info outputs.
# AC_LANG_CONFTEST(C)(BODY)
-# -----------------------
+# -------------------------
# We can't use '#line $LINENO "configure"' here, since
# Sun c89 (Sun WorkShop 6 update 2 C 5.3 Patch 111679-08 2002/05/09)
# rejects $LINENO greater than 32767, and some configure scripts
# AC_LANG_PREPROC(C)
-# -------------------
+# ------------------
# Find the C preprocessor. Must be AC_DEFUN'd to be AC_REQUIRE'able.
AC_DEFUN([AC_LANG_PREPROC(C)],
[AC_REQUIRE([AC_PROG_CPP])])
# AC_LANG_PREPROC(C++)
-# ---------------------
+# --------------------
# Find the C++ preprocessor. Must be AC_DEFUN'd to be AC_REQUIRE'able.
AC_DEFUN([AC_LANG_PREPROC(C++)],
[AC_REQUIRE([AC_PROG_CXXCPP])])
# AC_PROG_OBJCXX([LIST-OF-COMPILERS])
-# ---------------------------------
+# -----------------------------------
# LIST-OF-COMPILERS is a space separated list of Objective C++ compilers to
# search for (if not specified, a default list is used). This just gives
# the user an opportunity to specify an alternative search list for the
[AC_LANG_FUNC_LINK_TRY([omp_get_num_threads])])
# _AC_LANG_OPENMP(Fortran)
-# ---------------------------
+# ------------------------
m4_copy([_AC_LANG_OPENMP(Fortran 77)], [_AC_LANG_OPENMP(Fortran)])
# AC_OPENMP
# AC_LANG_ERLANG
-# -----------------
+# --------------
AU_DEFUN([AC_LANG_ERLANG], [AC_LANG(Erlang)])
[$0: No preprocessor defined for ]_AC_LANG)])
# AC_LANG_PREPROC(Fortran)
-# ---------------------------
+# ------------------------
# Find the Fortran preprocessor. Must be AC_DEFUN'd to be AC_REQUIRE'able.
AC_DEFUN([AC_LANG_PREPROC(Fortran)],
[m4_warn([syntax],
[AC_REQUIRE([AC_PROG_F77])])
# AC_LANG_COMPILER(Fortran)
-# ----------------------------
+# -------------------------
# Find the Fortran compiler. Must be AC_DEFUN'd to be
# AC_REQUIRE'able.
AC_DEFUN([AC_LANG_COMPILER(Fortran)],
# AC_PROG_FC_C_O
-# ---------------
+# --------------
AC_DEFUN([AC_PROG_FC_C_O],
[AC_REQUIRE([AC_PROG_FC])dnl
AC_LANG_PUSH(Fortran)dnl
# _AC_PROG_FC_V_OUTPUT([FLAG = $ac_cv_prog_{f77/fc}_v])
-# -------------------------------------------------
+# -----------------------------------------------------
# Link a trivial Fortran program, compiling with a verbose output FLAG
# (whose default value, $ac_cv_prog_{f77/fc}_v, is computed by
# _AC_PROG_FC_V), and return the output in $ac_{f77/fc}_v_output. This
# _AC_PROG_FC_V
-# --------------
+# -------------
#
# Determine the flag that causes the Fortran compiler to print
# information of library and object files (normally -v)
# AC_FC_LIBRARY_LDFLAGS
-# ----------------------
+# ---------------------
AC_DEFUN([AC_FC_LIBRARY_LDFLAGS],
[AC_REQUIRE([AC_PROG_FC])dnl
AC_LANG_PUSH(Fortran)dnl
# AC_F77_DUMMY_MAIN
-# ----------------------
+# -----------------
AC_DEFUN([AC_F77_DUMMY_MAIN],
[AC_REQUIRE([AC_F77_LIBRARY_LDFLAGS])dnl
AC_LANG_PUSH(Fortran 77)dnl
# AC_FC_DUMMY_MAIN
-# ----------------------
+# ----------------
AC_DEFUN([AC_FC_DUMMY_MAIN],
[AC_REQUIRE([AC_FC_LIBRARY_LDFLAGS])dnl
AC_LANG_PUSH(Fortran)dnl
# _AC_F77_NAME_MANGLING
-# ----------------------
+# ---------------------
AC_DEFUN([_AC_F77_NAME_MANGLING],
[AC_REQUIRE([AC_F77_LIBRARY_LDFLAGS])dnl
AC_REQUIRE([AC_F77_DUMMY_MAIN])dnl
# _AC_FC_NAME_MANGLING
-# ----------------------
+# --------------------
AC_DEFUN([_AC_FC_NAME_MANGLING],
[AC_REQUIRE([AC_FC_LIBRARY_LDFLAGS])dnl
AC_REQUIRE([AC_FC_DUMMY_MAIN])dnl
# AC_FUNC_FORK
-# -------------
+# ------------
AN_FUNCTION([fork], [AC_FUNC_FORK])
AN_FUNCTION([vfork], [AC_FUNC_FORK])
AC_DEFUN([AC_FUNC_FORK],
# _AC_FUNC_VFORK
-# -------------
+# --------------
AC_DEFUN([_AC_FUNC_VFORK],
[AC_CACHE_CHECK(for working vfork, ac_cv_func_vfork_works,
[AC_RUN_IFELSE([AC_LANG_SOURCE([[/* Thanks to Paul Eggert for this test. */
# AU::AC_FUNC_VFORK
-# ------------
+# -----------------
AU_ALIAS([AC_FUNC_VFORK], [AC_FUNC_FORK])
# AU::AC_VFORK
[AC_ARG_WITH([$1], [ --with-$1], [$2], [$3])])
# AC_DISABLE_OPTION_CHECKING
-# --------------------------------------------------------------------
+# --------------------------
AC_DEFUN([AC_DISABLE_OPTION_CHECKING],
[m4_divert_once([DEFAULTS], [enable_option_checking=no])
])# AC_DISABLE_OPTION_CHECKING
# _AC_CACHE_CHECK_INT(MESSAGE, CACHE-ID, EXPRESSION,
# [PROLOGUE = DEFAULT-INCLUDES], [IF-FAILS])
-# -------------------------------------------------------------
+# --------------------------------------------------------------
AC_DEFUN([_AC_CACHE_CHECK_INT],
[AC_CACHE_CHECK([$1], [$2],
[AC_COMPUTE_INT([$2], [$3], [$4], [$5])])
# AC_TRY_RUN(PROGRAM,
# [ACTION-IF-TRUE], [ACTION-IF-FALSE],
# [ACTION-IF-CROSS-COMPILING = RUNTIME-ERROR])
-# --------------------------------------------------------
+# -------------------------------------------------------
AU_DEFUN([AC_TRY_RUN],
[AC_RUN_IFELSE([AC_LANG_SOURCE([[$1]])], [$2], [$3], [$4])])
# AC_LIBSOURCES([FILE-NAME1, ...])
-# -------------------------------
+# --------------------------------
# Announce we might need these files.
AC_DEFUN([AC_LIBSOURCES],
[m4_map_args([AC_LIBSOURCE], $1)])
# AC_LIBOBJ(FILE-NAME-NOEXT)
-# -------------------------
+# --------------------------
# We need `FILE-NAME-NOEXT.o', save this into `LIBOBJS'.
AC_DEFUN([AC_LIBOBJ],
[_AC_LIBOBJ([$1],
# _AC_LANG_NULL_PROGRAM
-# ----------------------
+# ---------------------
# Produce valid source for the current language that does
# nothing.
AC_DEFUN([_AC_LANG_NULL_PROGRAM],
# _AC_LANG_IO_PROGRAM
-# -----------------------------------
+# -------------------
# Produce valid source for the current language that creates
# a file. (This is used when detecting whether executables
# work, e.g. to detect cross-compiling.)
## ------------------------------- ##
# AC_LANG_WERROR
-# ------------------
+# --------------
# Treat warnings from the current language's preprocessor, compiler, and
# linker as fatal errors.
AC_DEFUN([AC_LANG_WERROR],
# AC_PATH_PROGS_FEATURE_CHECK(VARIABLE, PROGNAME-LIST,
# FEATURE-TEST, [ACTION-IF-NOT-FOUND=:],
# [PATH=$PATH])
-# ----------------------------------------------------------------
+# ------------------------------------------------------------------
# Designed to be used inside AC_CACHE_VAL. It is recommended,
# but not required, that the user also use AC_ARG_VAR([VARIABLE]).
# If VARIABLE is not empty, set the cache variable
# CACHE-VAR,
# DESCRIPTION,
# PROLOGUE, [FUNCTION-BODY])
-# ----------------------------------------------------------
+# --------------------------------------------------------
m4_define([_AC_SYS_LARGEFILE_MACRO_VALUE],
[AC_CACHE_CHECK([for $1 value needed for large files], [$3],
[while :; do
# AC_GNU_SOURCE
-# --------------
+# -------------
AU_DEFUN([AC_GNU_SOURCE], [AC_USE_SYSTEM_EXTENSIONS])
# _AC_CONFIG_DEPENDENCY(MODE, DEST[:SOURCE1...])
-# ---------------------------------------------
+# ----------------------------------------------
# MODE is `FILES', `HEADERS', or `LINKS'.
#
# Be sure that a missing dependency is expressed as a dependency upon
# AC_TYPE_INTMAX_T
-# -----------------
+# ----------------
AC_DEFUN([AC_TYPE_INTMAX_T],
[
AC_REQUIRE([AC_TYPE_LONG_LONG_INT])
# AC_TYPE_INTPTR_T
-# -----------------
+# ----------------
AC_DEFUN([AC_TYPE_INTPTR_T],
[
AC_CHECK_TYPE([intptr_t],
[^\([^.]*\)\.\(.*\)], [[\2' is a member of `\1]])['.])]])
# AC_CHECK_MEMBERS([AGGREGATE.MEMBER, ...],
-# [ACTION-IF-FOUND], [ACTION-IF-NOT-FOUND]
+# [ACTION-IF-FOUND], [ACTION-IF-NOT-FOUND],
# [INCLUDES = DEFAULT-INCLUDES])
-# ---------------------------------------------------------
+# ----------------------------------------------------------
# The first argument is an m4 list.
AC_DEFUN([AC_CHECK_MEMBERS],
[m4_map_args_sep([AC_CHECK_MEMBER(_$0(], [)[
])
# AC_STRUCT_DIRENT_D_INO
-# -----------------------------------
+# ----------------------
AC_DEFUN([AC_STRUCT_DIRENT_D_INO], [_AC_STRUCT_DIRENT([d_ino])])
# AC_STRUCT_DIRENT_D_TYPE
-# ------------------------------------
+# -----------------------
AC_DEFUN([AC_STRUCT_DIRENT_D_TYPE], [_AC_STRUCT_DIRENT([d_type])])
m4_append([_AT_DEFINE_INIT_LIST], [[$1]], [,])])
# _AT_DEFINE_SETUP(NAME, [DEFINITION])
-# -----------------------------------
+# ------------------------------------
# Define macro NAME to die if invoked outside AT_SETUP/AT_CLEANUP, and
# to DEFINITION otherwise.
m4_define([_AT_DEFINE_SETUP],
# AT_ARG_OPTION_ARG(OPTIONS,HELP-TEXT,[ACTION-IF-GIVEN],[ACTION-IF-NOT-GIVEN])
-# ---------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
# Accept a set of OPTIONS with arguments, seperated by commas. Add HELP-TEXT
# to the HELP_OTHER diversion.
#
# AT_FAIL_IF(SHELL-EXPRESSION)
-# -----------------------------
+# ----------------------------
# Make the test die with hard failure if SHELL-EXPRESSION evaluates to
# true (exitcode = 0).
_AT_DEFINE_SETUP([AT_FAIL_IF],
# AT_SKIP_IF(SHELL-EXPRESSION)
-# -----------------------------
+# ----------------------------
# Skip the rest of the group if SHELL-EXPRESSION evaluates to true
# (exitcode = 0).
_AT_DEFINE_SETUP([AT_SKIP_IF],
## ------------------------ ##
-## Erlang EUnit unit tests. ##
+## Erlang EUnit unit tests. ##
## ------------------------ ##
# AT_CHECK_EUNIT(MODULE, SPEC, [ERLFLAGS], [RUN-IF-FAIL], [RUN-IF-PASS])
# AS_LINENO_POP([LINENO])
-# ------------------------
+# -----------------------
# If this is call balances the outermost call to AS_LINENO_PUSH,
# AS_MESSAGE will restart printing $LINENO as the line number.
m4_defun([AS_LINENO_POP],
# _AS_DIRNAME_PREPARE
-# --------------------
+# -------------------
m4_defun([_AS_DIRNAME_PREPARE],
[AS_REQUIRE([_AS_EXPR_PREPARE])]dnl
[if (as_dir=`dirname -- /` && test "X$as_dir" = X/) >/dev/null 2>&1; then
# AS_ECHO_N(WORD)
-# -------------
+# ---------------
# Like AS_ECHO(WORD), except do not output the trailing newline.
m4_defun_init([AS_ECHO_N],
[AS_REQUIRE([_AS_ECHO_PREPARE])],
# _AS_ECHO_PREPARE
-# -----------------
+# ----------------
# Arrange for $as_echo 'FOO' to echo FOO without escape-interpretation;
# and similarly for $as_echo_n, which omits the trailing newline.
# 'FOO' is an optional single argument; a missing FOO is treated as empty.
])
# _AS_LINENO_WORKS
-# ---------------
+# ----------------
# Succeed if the currently executing shell supports LINENO.
# This macro does not expand to a single shell command, so be careful
# when using it. Surrounding the body of this macro with {} would
# AS_VERSION_COMPARE(VERSION-1, VERSION-2,
# [ACTION-IF-LESS], [ACTION-IF-EQUAL], [ACTION-IF-GREATER])
-# -----------------------------------------------------------------------------
+# ----------------------------------------------------------------------------
# Compare two strings possibly containing shell variables as version strings.
#
# This usage is portable even to ancient awk,
# m4_shift2(...)
# m4_shift3(...)
-# -----------------
+# --------------
# Returns ... shifted twice, and three times. Faster than m4_shiftn.
m4_define([m4_shift2], [m4_shift(m4_shift($@))])
m4_define([m4_shift3], [m4_shift(m4_shift(m4_shift($@)))])
# m4_divert_stack
-# ------------------
+# ---------------
# Print the diversion stack, if it's nonempty. The caller is
# responsible for any leading or trailing newline.
m4_define([m4_divert_stack],
# m4_divert_require(DIVERSION, NAME-TO-CHECK, [BODY-TO-EXPAND])
-# --------------------------------------------------------------
+# -------------------------------------------------------------
# Same as m4_require, but BODY-TO-EXPAND goes into the named DIVERSION;
# requirements still go in the current diversion though.
#
# m4_cr_symbols1
# m4_cr_symbols2
-# -------------------------------
+# --------------
m4_define([m4_cr_symbols1],
m4_defn([m4_cr_Letters])dnl
_)
])# AT_CHECK_AT
# AT_CHECK_AT_TEST(TITLE, SUITE-SNIPPET, ...)
-# -----------------------------------------------------------------------
+# -------------------------------------------
# Wrapper for AT_CHECK_AT that surrounds SUITE-SNIPPET with a boilerplate
# AT_INIT, AT_SETUP, and AT_CLEANUP and passes other arguments verbatim.
m4_define([AT_CHECK_AT_TEST],
## Funny characters in test names. ##
## ------------------------------- ##
-# AT_CHECK_AT_TITLE(TITLE, TITLE-TO-TEST, EXPANDED-TITLE-TO-TEST
+# AT_CHECK_AT_TITLE(TITLE, TITLE-TO-TEST, EXPANDED-TITLE-TO-TEST,
# [XFAIL-CONDITION], [COLUMN = 53])
# ---------------------------------------------------------------
# Create a new test named TITLE that runs an Autotest test suite
# AT_CHECK_CONFIGURE(END-COMMAND,
# [EXIT-STATUS = 0],
# [STDOUT = IGNORE], STDERR)
-# --------------------------------------------
+# ---------------------------------------------
# `abs_top_srcdir' is needed so that `./configure' finds install-sh.
# Using --srcdir is more expensive.
m4_define([AT_CHECK_CONFIGURE],
## --------------------------- ##
-## Nested AS_REQUIRE_SHELL_FN ##
+## Nested AS_REQUIRE_SHELL_FN. ##
## --------------------------- ##
# Hypothesis: M4sh expands nested AS_REQUIRE_SHELL_FN
# AC_CHECK_MEMBER
-# ----------------
+# ---------------
# Check that it performs the correct actions.
# Must define HAVE_STRUCT_YES_S_YES, but not HAVE_STRUCT_YES_S_NO.
AT_CHECK_MACRO([AC_CHECK_MEMBER],
# autoconf: AC_AUTOCONF_VERSION
-# --------------------------------------
+# -----------------------------
AT_SETUP([autoconf: AC_AUTOCONF_VERSION])
AT_DATA([configure.ac],
# autotools and file names containing whitespace
-# ---------------------------------------------
+# ----------------------------------------------
AT_SETUP([autotools and whitespace in file names])
# AT_CHECK_CONFIG_CREATION_NOWRITE(THING = (header | link | file | command))
-# ------------------------------------------------------------------
+# --------------------------------------------------------------------------
# Check that THING and var-THING (which uses variables in AC_CONFIG_THING)
# are properly created, with the right content.
# Use `grep OK' instead of a simple `cat' to avoid banners such as in
projects / thirdparty / autoconf.git / commitdiff
