[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 6/8] docs: fix names of relevant test cases in comments
From: |
Stefano Lattarini |
Subject: |
[PATCH 6/8] docs: fix names of relevant test cases in comments |
Date: |
Sun, 8 Apr 2012 14:55:27 +0200 |
* doc/automake.texi: In comments reporting which test(s) check a
given feature/idiom, fix the names of the referenced tests, to
reflect the recent 'tests/foo.test' => 't/foo.sh' "Great Rename".
Signed-off-by: Stefano Lattarini <address@hidden>
---
doc/automake.texi | 96 ++++++++++++++++++++++++++--------------------------
1 files changed, 48 insertions(+), 48 deletions(-)
diff --git a/doc/automake.texi b/doc/automake.texi
index 773db0a..b309684 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -913,7 +913,7 @@ GNU Make Manual}).
VPATH builds have other interesting uses. One is to build the same
sources with multiple configurations. For instance:
address@hidden Keep in sync with amhello-cflags.test.
address@hidden Keep in sync with amhello-cflags.sh
@example
~ % @kbd{tar zxf ~/amhello-1.0.tar.gz}
~ % @kbd{cd amhello-1.0}
@@ -1065,7 +1065,7 @@ instance my cross-compiler for MinGW32 has its binaries
called
Here is how we could build @code{amhello-1.0} for
@code{i586-mingw32msvc} on a GNU/Linux PC.
address@hidden Keep in sync with amhello-cross-compile.test.
address@hidden Keep in sync with amhello-cross-compile.sh
@smallexample
~/amhello-1.0 % @kbd{./configure --build i686-pc-linux-gnu --host
i586-mingw32msvc}
checking for a BSD-compatible install... /usr/bin/install -c
@@ -1180,7 +1180,7 @@ by some means.
For instance here is how we could create a binary package containing a
snapshot of all the files to be installed.
address@hidden Keep in sync with amhello-binpkg.test.
address@hidden Keep in sync with amhello-binpkg.sh
@example
~/amhello-1.0 % @kbd{./configure --prefix /usr}
@dots{}
@@ -1832,11 +1832,11 @@ variable definitions.
Generally, Automake is not particularly smart in the parsing of unusual
Makefile constructs, so you're advised to avoid fancy constructs or
``creative'' use of whitespaces.
address@hidden Keep this in sync with doc-parsing-buglets-tabs.test.
address@hidden Keep this in sync with doc-parsing-buglets-tabs.sh
For example, @key{TAB} characters cannot be used between a target name
and the following address@hidden:}'' character, and variable assignments
shouldn't be indented with @key{TAB} characters.
address@hidden Keep this in sync with doc-parsing-buglets-colneq-subst.test.
address@hidden Keep this in sync with doc-parsing-buglets-colneq-subst.sh
Also, using more complex macro in target names can cause trouble:
@example
@@ -1877,7 +1877,7 @@ When examining a variable definition, Automake will
recursively examine
variables referenced in the definition. For example, if Automake is
looking at the content of @code{foo_SOURCES} in this snippet
address@hidden Keep in sync with interp.test.
address@hidden Keep in sync with interp.sh
@example
xs = a.c b.c
foo_SOURCES = c.c $(xs)
@@ -2061,7 +2061,7 @@ defined (e.g., @samp{zardir}).
For instance, the following snippet will install @file{file.xml} into
@samp{$(datadir)/xml}.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
@example
xmldir = $(datadir)/xml
xml_DATA = file.xml
@@ -2072,7 +2072,7 @@ performs to diagnose suspicious directory/primary couples
(in the
unlikely case these checks are undesirable, and you really know what
you're doing). For example, Automake would error out on this input:
address@hidden Should be tested in primary-prefix-invalid-couples.test.
address@hidden Should be tested in primary-prefix-invalid-couples.sh
@example
# Forbidden directory combinations, automake will error out on this.
pkglib_PROGRAMS = foo
@@ -2082,7 +2082,7 @@ doc_LIBRARIES = libquux.a
@noindent
but it will succeed with this:
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
@example
# Work around forbidden directory combinations. Do not use this
# without a very good reason!
@@ -2163,7 +2163,7 @@ data_DATA = file1 @dots{} address@hidden address@hidden
@dots{} address@hidden
@noindent
may also be written as
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
@example
data_DATA = file1 @dots{} address@hidden
data2dir = $(datadir)
@@ -2489,7 +2489,7 @@ example in the manual. However if you were to build
@code{true} and
@code{false} in real life, you would probably use per-program
compilation flags, like so:
address@hidden Keep in sync with specflg7.test and specflg8.test.
address@hidden Keep in sync with specflg7.sh and specflg8.sh
@example
bin_PROGRAMS = false true
@@ -2719,7 +2719,7 @@ are enabled in @option{--gnu} and @option{--gnits}
strictness.
On the other hand, the @option{silent-rules} options (@pxref{Options})
turns off portability warnings about recursive variable expansions.
address@hidden Checked by extra-portability.test
address@hidden Checked by extra-portability.sh
Turning off @samp{portability} will also turn off @samp{extra-portability},
and similarly turning on @samp{extra-portability} will also turn on
@samp{portability}. However, turning on @samp{portability} or turning
@@ -2834,7 +2834,7 @@ literals. If part of the specification uses shell
variables,
@command{automake} will not be able to fulfill this setup, and you will
have to complete the missing bits by hand. For instance, on
address@hidden Keep in sync with output11.test.
address@hidden Keep in sync with output11.sh
@example
file=input
@dots{}
@@ -2850,7 +2850,7 @@ source file.)
Similarly
address@hidden Keep in sync with output11.test.
address@hidden Keep in sync with output11.sh
@example
file=output
file2=out:in
@@ -3263,7 +3263,7 @@ Add the directory @var{dir} to the list of directories
searched for
Install system-wide third-party macros into the first directory
specified with @samp{-I @var{dir}} instead of copying them in the
output file.
address@hidden The following semantics is checked by
`aclocal-install-absdir.test'.
address@hidden Keep in sync with aclocal-install-absdir.sh
Note that this will happen also if @var{dir} is an absolute path.
@cindex serial number and @option{--install}
@@ -3479,18 +3479,18 @@ macros installed at other places on the system.
The fourth and last mechanism to customize the macro search path is
also the simplest. Any directory included in the colon-separated
environment variable @env{ACLOCAL_PATH} is added to the search path
address@hidden Keep in sync with aclocal-path-precedence.test.
address@hidden Keep in sync with aclocal-path-precedence.sh
and takes precedence over system directories (including those found via
@file{dirlist}), with the exception of the versioned directory
@var{acdir-APIVERSION} (@pxref{Macro Search Path}). However, directories
passed via @option{-I} will take precedence over directories in
@env{ACLOCAL_PATH}.
address@hidden Keep in sync with aclocal-path-installed.test.
address@hidden Keep in sync with aclocal-path-installed.sh
Also note that, if the @option{--install} option is used, any @file{.m4}
file containing a required macro that is found in a directory listed in
@env{ACLOCAL_PATH} will be installed locally.
address@hidden Keep in sync with aclocal-path-installed-serial.test.
address@hidden Keep in sync with aclocal-path-installed-serial.sh
In this case, serial numbers in @file{.m4} are honoured too,
@pxref{Serials}.
@@ -3526,7 +3526,7 @@ installs this macro so that @command{aclocal} will find
it.
A macro file's name should end in @file{.m4}. Such files should be
installed in @file{$(datadir)/aclocal}. This is as simple as writing:
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
@example
aclocaldir = $(datadir)/aclocal
aclocal_DATA = mymacro.m4 myothermacro.m4
@@ -4339,7 +4339,7 @@ does not know the possible values of these variables. In
this case
@cindex @code{SUBDIRS} and @code{AM_CONDITIONAL}
@cindex @code{AM_CONDITIONAL} and @code{SUBDIRS}
address@hidden Keep in sync with subcond2.test.
address@hidden Keep in sync with subcond2.sh
@file{configure} should output the @file{Makefile} for each directory
and define a condition into which @file{opt/} should be built.
@@ -4379,7 +4379,7 @@ automatically because it knows that @code{MAYBE_OPT} can
contain
@cindex @code{SUBDIRS} and @code{AC_SUBST}
@cindex @code{AC_SUBST} and @code{SUBDIRS}
address@hidden Keep in sync with subcond3.test.
address@hidden Keep in sync with subcond3.sh
Another possibility is to define @code{MAYBE_OPT} from
@file{./configure} using @code{AC_SUBST}:
@@ -4537,7 +4537,7 @@ often be replaced by several variables, one for each
destination
directory (@pxref{Uniform}). For instance, the last example could be
rewritten as follows:
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
@example
imagesdir = $(pkgdatadir)/images
soundsdir = $(pkgdatadir)/sounds
@@ -4993,7 +4993,7 @@ You can also use Automake conditionals
(@pxref{Conditionals}) to
select programs to be built. In this case you don't have to worry
about @samp{$(EXEEXT)} or @code{EXTRA_PROGRAMS}.
address@hidden Keep in sync with exeext.test.
address@hidden Keep in sync with exeext.sh
@example
bin_PROGRAMS = cpio pax
if WANT_MT
@@ -5044,7 +5044,7 @@ Extra objects can be added to a library using the
@address@hidden variable. This should be used for objects
determined by @command{configure}. Again from @code{cpio}:
address@hidden Keep in sync with pr401c.test.
address@hidden Keep in sync with pr401c.sh
@example
libcpio_a_LIBADD = $(LIBOBJS) $(ALLOCA)
@end example
@@ -5250,7 +5250,7 @@ relates to @file{libfoo.la} or @file{libbar.la} at the
time it creates
the link rule for these two libraries. Therefore the @option{-rpath}
argument must be explicitly supplied.
address@hidden Keep in sync with ltcond.test.
address@hidden Keep in sync with ltcond.sh
@example
EXTRA_LTLIBRARIES = libfoo.la libbar.la
lib_LTLIBRARIES = $(WANTEDLIBS)
@@ -5266,7 +5266,7 @@ Automake is able to compute the @option{-rpath} setting
itself, because
it's clear that both libraries will end up in @samp{$(libdir)} if they
are installed.
address@hidden Keep in sync with ltcond.test.
address@hidden Keep in sync with ltcond.sh
@example
lib_LTLIBRARIES =
if WANT_LIBFOO
@@ -5293,7 +5293,7 @@ we could build a @file{libhello.la} library using either
@file{hello-linux.c} or @file{hello-generic.c} with the following
@file{Makefile.am}.
address@hidden Keep in sync with ltcond2.test.
address@hidden Keep in sync with ltcond2.sh
@example
lib_LTLIBRARIES = libhello.la
libhello_la_SOURCES = hello-common.c
@@ -5308,7 +5308,7 @@ either @file{hello-linux.lo} or @address@hidden
Or we could simply use an Automake conditional as follows.
address@hidden Keep in sync with ltcond2.test.
address@hidden Keep in sync with ltcond2.sh
@example
lib_LTLIBRARIES = libhello.la
libhello_la_SOURCES = hello-common.c
@@ -5348,7 +5348,7 @@ dependency anywhere it won't be built (this is why
Here is a sample setup merging libtool convenience libraries from
subdirectories into one main @file{libtop.la} library.
address@hidden Keep in sync with ltconv.test.
address@hidden Keep in sync with ltconv.sh
@example
# -- Top-level Makefile.am --
SUBDIRS = sub1 sub2 @dots{}
@@ -7516,7 +7516,7 @@ variable explicitly prevents byte-compilation.
Since Automake 1.8, we now recommend using @code{lisp_DATA} instead:
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
@example
lisp_DATA = file1.el file2.el
@end example
@@ -7578,7 +7578,7 @@ files are not included in the distribution, you should
use the
Here is a typical setup for distributing @file{.java} files and
installing the @file{.class} files resulting from their compilation.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
@example
javadir = $(datadir)/java
dist_java_JAVA = a.java b.java @dots{}
@@ -7652,7 +7652,7 @@ Automake ships with an Autoconf macro called
@code{AM_PATH_PYTHON}
that will determine some Python-related directory variables (see
below). If you have called @code{AM_PATH_PYTHON} from
@file{configure.ac}, then you may use the variables
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
@code{python_PYTHON} or @code{pkgpython_PYTHON} to list Python source
files in your @file{Makefile.am}, depending on where you want your files
installed (see the definitions of @code{pythondir} and
@@ -7741,7 +7741,7 @@ This is the directory where Python extension modules
(shared libraries)
should be installed. An extension module written in C could be declared
as follows to Automake:
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
@example
pyexec_LTLIBRARIES = quaternion.la
quaternion_la_SOURCES = quaternion.c support.c support.h
@@ -7945,7 +7945,7 @@ passed to @code{makeinfo} when building @file{.info}
files; and
@samp{$(AM_MAKEINFOHTMLFLAGS)} is used when building @file{.html}
files.
address@hidden Keep in sync with txinfo21.test.
address@hidden Keep in sync with txinfo21.sh
For instance, the following setting can be used to obtain one single
@file{.html} file per manual, without node separators.
@example
@@ -8173,7 +8173,7 @@ while @code{bin_PROGRAMS} files are installed by
@code{install-exec}.
Any variable using a user-defined directory prefix with
@samp{exec} in the name (e.g.,
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
@code{myexecbin_PROGRAMS}) is installed by @code{install-exec}. All
other user-defined prefixes are installed by @code{install-data}.
@@ -8360,7 +8360,7 @@ included if they are found in the current directory
(either physically,
or as the target of a @file{Makefile.am} rule); this list is printed by
@samp{automake --help}. Note that some files in this list are actually
distributed only if other certain conditions hold (for example,
address@hidden Keep in sync with autodist-config-headers.test.
address@hidden Keep in sync with autodist-config-headers.sh
the @file{config.h.top} and @file{config.h.bot} files are automatically
distributed only if, e.g., @samp{AC_CONFIG_HEADERS([config.h])} is used
in @file{configure.ac}). Also, files that are read by @command{configure}
@@ -8577,7 +8577,7 @@ If you want @code{distcleancheck} to ignore built files
that have not
been cleaned because they are also part of the distribution, add the
following definition instead:
address@hidden Keep in sync with distcleancheck.test.
address@hidden Keep in sync with distcleancheck.sh
@example
distcleancheck_listfiles = \
find . -type f -exec sh -c 'test -f $(srcdir)/$$1 || echo $$1' \
@@ -8826,7 +8826,7 @@ the @code{DISABLE_HARD_ERRORS} make variable to a
nonempty value.
Note however that, for tests based on more complex test protocols,
the exact effects of @code{XFAIL_TESTS} and @code{DISABLE_HARD_ERRORS}
might change, or they might even have no effect at all (for example,
address@hidden Keep this in sync with tap-no-disable-hard-errors.test.
address@hidden Keep this in sync with tap-no-disable-hard-errors.sh
in tests using TAP, there is not way to disable hard errors, and the
@code{DISABLE_HARD_ERRORS} variable has no effect on them).
@@ -8842,7 +8842,7 @@ possible results (whose meanings should be clear from the
previous
@code{SKIP}, @code{XFAIL}, @code{XPASS} and @code{ERROR}. Here is an
example of output from an hypothetical testsuite that uses both plain
and TAP tests:
address@hidden Keep in sync with tap-doc.test.
address@hidden Keep in sync with tap-doc.sh
@example
PASS: foo.sh
PASS: zardoz.tap 1 - Daemon started
@@ -8906,7 +8906,7 @@ HP-UX's @command{/bin/sh},
@c FIXME: should we offer a link to the relevant discussions on the
@c bug-autoconf list?
address@hidden Keep in sync with tests-environment-backcompat.test.
address@hidden Keep in sync with tests-environment-backcompat.sh
@example
AM_TESTS_ENVIRONMENT = \
## Some environment initializations are kept in a separate shell
@@ -9051,7 +9051,7 @@ suffixes. @code{TEST_EXTENSIONS} defaults to
@file{.test}; it can be
overridden by the user, in which case any extension listed in it must be
constituted by a dot, followed by a non-digit alphabetic character,
followed by any number of alphabetic characters.
address@hidden Keep in sync with test-extensions.test.
address@hidden Keep in sync with test-extensions.sh
For example, @samp{.sh}, @samp{.T} and @samp{.t1} are valid extensions,
while @samp{.x-y}, @samp{.6c} and @samp{.t.1} are not.
@@ -9075,7 +9075,7 @@ all tests with this extension to be called with this
runner. For all
tests without a registered extension, the variables @code{LOG_COMPILER},
@code{AM_LOG_FLAGS}, and @code{LOG_FLAGS} may be used. For example,
address@hidden Keep in sync with parallel-tests-log-compiler-example.test.
address@hidden Keep in sync with parallel-tests-log-compiler-example.sh
@example
TESTS = foo.pl bar.py baz
TEST_EXTENSIONS = .pl .py
@@ -9132,7 +9132,7 @@ whose testsuite takes long time to execute. Luckily,
this problem can
easily be avoided by overriding also @code{TEST_SUITE_LOG} at runtime;
for example,
address@hidden Keep in sync with parallel-tests-log-override-2.test.
address@hidden Keep in sync with parallel-tests-log-override-2.sh
@example
env TEST_SUITE_LOG=partial.log TESTS="..." make -e check
@end example
@@ -9646,7 +9646,7 @@ don't use it if you can avoid it.
@noindent
Here is an example of how the TAP driver can be set up and used.
address@hidden Keep in sync with tap-doc2.test.
address@hidden Keep in sync with tap-doc2.sh
@example
% @kbd{cat configure.ac}
AC_INIT([GNU Try Tap], [1.0], [bug-automake@@gnu.org])
@@ -10447,7 +10447,7 @@ For instance, the following definition prevents
Automake from misinterpreting
the @samp{.idlC.cpp:} rule as an attempt to transform @file{.idlC} files into
@file{.cpp} files.
address@hidden Keep in sync with suffix7.test.
address@hidden Keep in sync with suffix7.sh
@example
SUFFIXES = .idl C.cpp
.idlC.cpp:
@@ -10902,7 +10902,7 @@ make silent rules enabled by default in his own package
can do so by
adding a @samp{yes} argument to the @code{AM_SILENT_RULES} call in
@file{configure.ac}. We advise against this approach, though.
address@hidden Keep in sync with silent-configsite.test
address@hidden Keep in sync with silent-configsite.sh
Users who prefer to have silent rules enabled by default can edit their
@file{config.site} file to make the variable @code{enable_silent_rules}
default to @samp{yes}. This should still allow disabling silent rules
@@ -11268,7 +11268,7 @@ Checks, autoconf, The Autoconf Manual}) and use
@samp{$(LN_S)} in
For instance, here is how you could install a versioned copy of a
program using @samp{$(LN_S)}:
address@hidden Keep in sync with insthook.test
address@hidden Keep in sync with insthook.sh
@example
install-exec-hook:
cd $(DESTDIR)$(bindir) && \
@@ -11284,7 +11284,7 @@ When writing @code{install-exec-hook} or
@code{install-data-hook},
please bear in mind that the exec/data distinction is based on the
installation directory, not on the primary used (@pxref{The Two Parts of
Install}).
address@hidden Keep in sync with primary-prefix-couples-documented-valid.test.
address@hidden Keep in sync with primary-prefix-couples-documented-valid.sh
So a @code{foo_SCRIPTS} will be installed by
@code{install-data}, and a @code{barexec_SCRIPTS} will be installed by
@code{install-exec}. You should define your hooks consequently.
--
1.7.9
- Re: [PATCH] maint: remove most recursion in automake's own build system, (continued)
- Re: [PATCH] maint: remove most recursion in automake's own build system, Jim Meyering, 2012/04/05
- Re: [PATCH] maint: remove most recursion in automake's own build system, Stefano Lattarini, 2012/04/06
- Re: [PATCH] maint: remove most recursion in automake's own build system, Jim Meyering, 2012/04/05
- Re: [PATCH] maint: remove most recursion in automake's own build system, Stefano Lattarini, 2012/04/05
- Re: [PATCH] maint: remove most recursion in automake's own build system, Stefano Lattarini, 2012/04/06
- Re: [PATCH] maint: remove most recursion in automake's own build system, Jim Meyering, 2012/04/06
- Re: [PATCH] maint: remove most recursion in automake's own build system, Stefano Lattarini, 2012/04/08
- [PATCH 1/8] tests: move most helper scripts and files into the 'ax' subdirectory, Stefano Lattarini, 2012/04/08
- [PATCH 2/8] tests: remove recipes that run tests with 'prove', Stefano Lattarini, 2012/04/08
- [PATCH 5/8] NEWS: automake build systems avoids make recursion, Stefano Lattarini, 2012/04/08
- [PATCH 6/8] docs: fix names of relevant test cases in comments,
Stefano Lattarini <=
- [PATCH 7/8] t/README: update w.r.t. recent overhaul (non-recursive build system), Stefano Lattarini, 2012/04/08
- [PATCH 8/8] maint: simplify generation of files with @substed@ stuff, Stefano Lattarini, 2012/04/08
- Re: [PATCH 8/8] maint: simplify generation of files with @substed@ stuff, Stefano Lattarini, 2012/04/08
- [PATCH 4/8] maint: no more make recursion in Automake's build system, Stefano Lattarini, 2012/04/08
- [PATCH 3/8] tests: rename 'tests/' => 't/', '*.test' => '*.sh', Stefano Lattarini, 2012/04/08
- Re: [PATCH] maint: remove most recursion in automake's own build system, Stefano Lattarini, 2012/04/11