summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStefano Lattarini <stefano.lattarini@gmail.com>2011-06-23 23:31:27 +0200
committerStefano Lattarini <stefano.lattarini@gmail.com>2011-06-27 15:35:16 +0200
commit404882ab2ac0a9447f6eccb2fa218df70582f488 (patch)
treea3af86be358070a8ce8ecdef528ed65e433a91f8 /doc
parent5755b7bcbd3892eb6aa31542fc7e2435a0de11ab (diff)
downloadautomake-404882ab2ac0a9447f6eccb2fa218df70582f488.tar.gz
docs: avoid a footnote, some related rewordings and improvements
* doc/automake.texi (Dist): Reword the part about automatically distributed files to avoid a footnote. Since we are at it, extend a bit, and add an example and a reference to a relevant test case.
Diffstat (limited to 'doc')
-rw-r--r--doc/automake.texi15
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/automake.texi b/doc/automake.texi
index bd4b4a70a..964dc1184 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -8292,16 +8292,19 @@ is run. The default setting is @option{--best}.
@cmindex include
For the most part, the files to distribute are automatically found by
Automake: all source files are automatically included in a distribution,
-as are all @file{Makefile.am}s and @file{Makefile.in}s. Automake also
+as are all @file{Makefile.am} and @file{Makefile.in} files. Automake also
has a built-in list of commonly used files that are automatically
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}@footnote{Note that some of these files are actually
-distributed only when other certain conditions hold}. Also, files that
-are read by @command{configure}
+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,
+@c The following example is covered by autodist-config-headers.test.
+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}
(i.e.@: the source files corresponding to the files specified in various
Autoconf macros such as @code{AC_CONFIG_FILES} and siblings) are
-automatically distributed. Files included in @file{Makefile.am}s (using
+automatically distributed. Files included in a @file{Makefile.am} (using
@code{include}) or in @file{configure.ac} (using @code{m4_include}), and
helper scripts installed with @samp{automake --add-missing} are also
distributed.