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.

diff --git a/ChangeLog b/ChangeLog
index 14233a8c0a14dabb33185d6fecb28bd9c592ef71..2e17be5c2f0ecdca6d5f80e9b30f41ec4a372587 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2011-06-23   Stefano Lattarini  <stefano.lattarini@gmail.com>
+
+       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.
+
 2011-06-23   Stefano Lattarini  <stefano.lattarini@gmail.com>
 
        docs: minor cosmetic fixes

diff --git a/doc/automake.texi b/doc/automake.texi
index bd4b4a70aa37190a4f8dec6954f2116c96203251..964dc11847f9df28edc92c48fcf490608e05d0bd 100644 (file)
--- 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.