FYI: revamp Headers node

[Alexandre Duret-Lutz]

I'm installing this on HEAD and branch-1-8.

2004-04-25  Alexandre Duret-Lutz  <address@hidden>

        * doc/automake.texi (Headers): Revamp.

Index: doc/automake.texi
===================================================================
RCS file: /cvs/automake/automake/doc/automake.texi,v
retrieving revision 1.18.2.12
diff -u -r1.18.2.12 automake.texi
--- doc/automake.texi   22 Mar 2004 20:29:41 -0000      1.18.2.12
+++ doc/automake.texi   25 Apr 2004 09:58:08 -0000
@@ -4224,30 +4224,57 @@
 @cindex Primary variable, HEADERS
 
 @vindex noinst_HEADERS
-
-Header files are specified by the @samp{HEADERS} family of variables.
-Generally header files are not installed, so the @code{noinst_HEADERS}
-variable will be the most used.  @footnote{However, for the case of a
-non-installed header file that is actually used by a particular program,
-we recommend listing it in the program's @samp{_SOURCES} variable
-instead of in @code{noinst_HEADERS}.  We believe this is more clear.}
address@hidden HEADERS
-
-All header files must be listed somewhere; missing ones will not appear
-in the distribution.  Often it is clearest to list uninstalled headers
-with the rest of the sources for a program.  @xref{A Program}.  Headers
-listed in a @samp{_SOURCES} variable need not be listed in any
address@hidden variable.
-
 @cindex HEADERS, installation directories
 @cindex Installing headers
-
 @vindex include_HEADERS
 @vindex oldinclude_HEADERS
 @vindex pkginclude_HEADERS
 
-Headers can be installed in @code{includedir}, @code{oldincludedir}, or
address@hidden
+
+Header files that must be installed are specified by the
address@hidden family of variables.  Headers can be installed in
address@hidden, @code{oldincludedir}, @code{pkgincludedir} or any
+other directory you may have defined (@pxref{Uniform}).  For instance
+
address@hidden
+include_HEADERS = foo.h bar/bar.h
address@hidden example
+
address@hidden
+will install the two files as @file{$(includedir)/foo.h} and
address@hidden(includedir)/bar.h}.
+
+The @samp{nobase_} prefix is also supported,
+
address@hidden
+nobase_include_HEADERS = foo.h bar/bar.h
address@hidden example
+
address@hidden
+will install the two files as @file{$(includedir)/foo.h} and
address@hidden(includedir)/bar/bar.h} (@pxref{Alternative}).
+
address@hidden noinst_HEADERS
+Usually, only header files that accompany installed libraries need to
+be installed.  Headers used by programs or convenience libraries are
+not installed.  The @code{noinst_HEADERS} variable can be used for
+such headers.  However when the header actually belongs to one
+convenient library or program, we recommend listing it in the
+program's or library's @samp{_SOURCES} variable (@pxref{Program
+Sources}) instead of in @code{noinst_HEADERS}.  This is clearer for
+the @file{Makefile.am} reader.  @code{noinst_HEADERS} would be the
+right variable to use in a directory containing only headers and no
+associated library or program.
+
+All header files must be listed somewhere; in a @samp{_SOURCES}
+variable or in a @samp{_HEADERS} variable.  Missing ones will not
+appear in the distribution.
+
+For header files that are built and must not be distributed, use the
address@hidden prefix as in @code{nodist_include_HEADERS} or
address@hidden  If these generated headers are needed
+during the build, you must also ensure they exist before they are
+used, see @xref{Sources}.
 
 
 @node Data

-- 
Alexandre Duret-Lutz