]> git.ipfire.org Git - thirdparty/automake.git/commitdiff
More doc changes
authorTom Tromey <tromey@redhat.com>
Tue, 27 Feb 1996 06:12:37 +0000 (06:12 +0000)
committerTom Tromey <tromey@redhat.com>
Tue, 27 Feb 1996 06:12:37 +0000 (06:12 +0000)
automake.texi

index ecd48d6e8accbe56bd3b1de67bd1aed50270f272..2685f968d1525f810705ea2958366974ee14c4c7 100644 (file)
@@ -97,7 +97,7 @@ documents version @value{VERSION}.
 
 @menu
 * Introduction::                Automake's purpose
-* Invoking automake::           Creating a Makefile.in
+* Invoking Automake::           Creating a Makefile.in
 * Generalities::                General ideas
 * configure::                   Scanning configure.in
 * Top level::                   The top-level Makefile.am
@@ -189,7 +189,7 @@ Print a summary of the command line options and exit.
 Include all automatically generated dependency information
 (@pxref{Dependencies}) see dependencies) in the generated
 @file{Makefile.in}.  This is generally done when making a distribution;
-see @ref{distributions}.
+see @ref{Dist}.
 
 @item --install-missing
 Automake requires certain common files to exist in certain situations;
@@ -546,7 +546,7 @@ actually can be used to add any options to the linker command line.
 Sometimes, multiple programs are built in one directory but do not share
 the same link-time requirements.  In this case, you can use the
 @samp{prog_LDADD} variable (where @var{PROG} is the name of the program
-as it appears in some ``_PROGRAMS'' variable}) to override the global
+as it appears in some ``_PROGRAMS'' variable) to override the global
 @samp{LDADD}.  (If this variable exists for a given program, then that
 program is not linked using @samp{LDADD}.)
 @vindex _LDADD
@@ -558,8 +558,8 @@ built in the same directory, and has no such link requirement.  Also,
 is what cpio's @file{src/Makefile.am} looks like (abridged):
 
 @example
-bin_PROGRAMS = cpio pax @MT@
-libexec_PROGRAMS = @RMT@
+bin_PROGRAMS = cpio pax @@MT@@
+libexec_PROGRAMS = @@RMT@@
 EXTRA_PROGRAMS = mt rmt
 
 LDADD = ../lib/libcpio.a @@INTLLIBS@@
@@ -614,8 +614,8 @@ handled in the dependency-tracking scheme, see @xref{Dependencies}.
 @section Automatic de-ANSI-fication
 
 Although the GNU standards prohibit it, some GNU programs are written in
-ANSI C; see @ref{FIXME}.  This is possible because each source file can
-be ``de-ANSI-fied'' before the actual compilation takes place.
+ANSI C; see FIXME.  This is possible because each source file can be
+``de-ANSI-fied'' before the actual compilation takes place.
 
 If the @file{Makefile.am} variable @samp{AUTOMAKE_OPTIONS}
 @vindex AUTOMAKE_OPTIONS
@@ -635,6 +635,7 @@ Also, the package @file{configure.in} must call the macro
 
 
 @node Dependencies
+@section Automatic dependency tracking
 
 As a developer it is often painful to continually update the
 @file{Makefile.in} whenever the include-file dependencies change in a
@@ -748,7 +749,7 @@ texinfos-vars.am texinfos.am hack-make.sed nl-remove.sed
 
 
 @node Documentation
-@section Building documentation
+@chapter Building documentation
 
 Currently Automake provides support for Texinfo and man pages.
 
@@ -759,7 +760,7 @@ Currently Automake provides support for Texinfo and man pages.
 
 
 @node Texinfo
-@subsection Texinfo
+@section Texinfo
 
 If the current directory contains Texinfo source, you must declare it
 with the @samp{TEXINFOS} primary.  Generally Texinfo files are converted
@@ -797,11 +798,11 @@ Automake.
 
 
 @node Man pages
-@subsection Man pages
+@section Man pages
 
 A package can also include man pages.  (Though see the GNU standards on
 this matter, @ref{Man Pages, , , standards.info, The GNU Coding
-Standards}).  Man pages are declared using the @samp{MANS} primary.
+Standards}.)  Man pages are declared using the @samp{MANS} primary.
 Generally the @samp{man_MANS} macro is used.  Man pages are
 automatically installed in the correct subdirectory of @code{mandir},
 based on the file extension.
@@ -869,13 +870,13 @@ be defined to specify additional files to clean.  These variables are
 
 
 @node Dist
-@section What Goes in a Distribution
+@chapter What Goes in a Distribution
 
 The @samp{dist} target in the generated @file{Makefile.in} can be used
 to generate a gzip'd tar file for distribution.  The tar file is named
 based on the @var{PACKAGE} and @var{VERSION} variables.
-@vindex PACKAGE
-@vindex VERSION
+@cvindex PACKAGE
+@cvindex VERSION
 
 For the most part, the files to distribute are automatically found by
 Automake: all source files are automatically included in a distribution,
@@ -892,7 +893,7 @@ the @samp{DIST_OTHER} variable.
 @vindex DIST_OTHER
 
 
-@ndoe Options
+@node Options
 @chapter Changing Automake's Behavior
 
 Various features of Automake can be controlled by options in the
@@ -989,7 +990,7 @@ FIXME write this
 
 
 @node Extending
-@section When Automake Isn't Enough
+@chapter When Automake Isn't Enough
 
 Sometimes @code{automake} isn't enough.  Then you just lose.
 
@@ -1013,6 +1014,9 @@ install-data-local:
         $(INSTALL_DATA) $(srcdir)/afile /etc/afile
 @end example
 
+@c FIXME should include discussion of variables you can use in these
+@c rules
+
 
 @node Distributing
 @chapter Distributing @file{Makefile.in}s
@@ -1048,20 +1052,18 @@ convenient locally, but for all distributions to be Unicode.
 
 
 @node Variables
-@chapter Index of Variables
 @unnumbered Index of Variables
 
 @printindex vr
 
 
 @node Configure variables
-@chapter Index of Configure Variables and Macros
 @unnumbered Index of Configure Variables and Macros
 
 @printindex cv
 
 @node Targets
-@chapter Index of Targets
+@unnumbered Index of Targets
 
 FIXME