From 9ce2e02fd67f480909af78d5547886efe8a74280 Mon Sep 17 00:00:00 2001 From: Tom Tromey Date: Mon, 28 Apr 1997 07:15:33 +0000 Subject: [PATCH] doc update --- TODO | 5 ++--- automake.texi | 48 ++++++++++++++++++++++++++---------------------- stamp-vti | 2 +- version.texi | 2 +- 4 files changed, 30 insertions(+), 27 deletions(-) diff --git a/TODO b/TODO index eedd1729..e1336fbb 100644 --- a/TODO +++ b/TODO @@ -398,9 +398,6 @@ document rebuilding configure. CONFIGURE_DEPENDENCIES -- must document all variables that are supposed to be public knowledge -automake must be run in each directory with a configure.in -This is insufficiently clear - must document the targets required for integration with non-automake-using subdirs @@ -410,6 +407,8 @@ section on relationship to GNU make. include notes on parallel makes add a concept index +move discussion of cygwin32, etags, mkid under other gnu tools + ================================================================ Things to do for autoconf: diff --git a/automake.texi b/automake.texi index b30eebd1..943cb481 100644 --- a/automake.texi +++ b/automake.texi @@ -128,11 +128,11 @@ documents version @value{VERSION}. @node Introduction @chapter Introduction -Automake is a tool for automatically generating -@file{Makefile.in}s from files called @file{Makefile.am}. The -@file{Makefile.am} is basically a series of @code{make} macro -definitions (with rules being thrown in occasionally). The generated -@file{Makefile.in}s are compliant with the GNU Makefile standards. +Automake is a tool for automatically generating @file{Makefile.in}s from +files called @file{Makefile.am}. Each @file{Makefile.am} is basically a +series of @code{make} macro definitions (with rules being thrown in +occasionally). The generated @file{Makefile.in}s are compliant with the +GNU Makefile standards. The GNU Makefile Standards Document (@pxref{Makefile Conventions, , , standards, The GNU Coding Standards}) @@ -321,7 +321,8 @@ given in the GNU standards Standards}). Automake extends this list with @code{pkglibdir}, @code{pkgincludedir}, and @code{pkgdatadir}; these are the same as the non-@samp{pkg} -versions, but with @samp{@@PACKAGE@@} appended. +versions, but with @samp{@@PACKAGE@@} appended. For instance, +@code{pkglibdir} is defined as @code{$(datadir)/@@PACKAGE@@}. @cvindex PACKAGE For each primary, there is one additional variable named by prepending @@ -412,9 +413,10 @@ underscores when making macro references. E.g., if your program is named @section A simple example, start to finish Let's suppose you just finished writing @code{zardoz}, a program to make -your head float around. You've been using @code{autoconf} to provide a -portability framework, but your @file{Makefile.in}s have been ad-hoc. -You want to make them bulletproof, so you turn to @code{automake}. +your head float from vortex to vortex. You've been using +@code{autoconf} to provide a portability framework, but your +@file{Makefile.in}s have been ad-hoc. You want to make them +bulletproof, so you turn to @code{automake}. The first step is to update your @file{configure.in} to include the commands that @code{automake} needs. The simplest way to do this is to @@ -457,7 +459,8 @@ zardoz_LDADD = @@LIBOBJS@@ info_TEXINFOS = zardoz.texi @end example -Now you can run @code{automake} to generate your @file{Makefile.in}, and +Now you can run @code{automake --add-missing} to generate your +@file{Makefile.in} and grab any auxiliary files you might need, and you're done! @@ -465,10 +468,10 @@ you're done! @section A classic program @code{hello} is renowned for its classic simplicity and versatility. -What better place to begin a tour? The below shows how Automake could -be used with the Hello package. The examples below are from the latest -GNU Hello, but all the maintainer-only code has been stripped out, as -well as all copyright comments. +This section shows how Automake could be used with the Hello package. +The examples below are from the latest GNU Hello, but all the +maintainer-only code has been stripped out, as well as all copyright +comments. Of course, GNU Hello is somewhat more featureful than your traditional two-liner. GNU Hello is internationalized, does option processing, and @@ -544,7 +547,7 @@ EXTRA_DIST = hello.in testdata The script @file{hello} is generated by @code{configure}, and is the only test case. @code{make check} will run this test. -Last, @file{src/Makefile.am}, where all the real work is done: +Last we have @file{src/Makefile.am}, where all the real work is done: @example bin_PROGRAMS = hello @@ -1653,9 +1656,9 @@ uses @samp{AM_WITH_REGEX}, then any dependency on @file{rx.h} or @file{regex.h} should be removed, because the correct one cannot be known until the user configures the package. -As it turns out, @code{automake} is actually smart enough to handle this -particular case. It will also automatically omit @file{libintl.h} if -@samp{AM_GNU_GETTEXT} is used. +As it turns out, @code{automake} is actually smart enough to the +particular case of the regular expression header. It will also +automatically omit @file{libintl.h} if @samp{AM_GNU_GETTEXT} is used. Automatic dependency tracking can be suppressed by putting @code{no-dependencies} in the variable @code{AUTOMAKE_OPTIONS}. @@ -1956,7 +1959,7 @@ Texinfo source and info pages are all considered to be source for the purposes of making a distribution. Man pages are not currently considered to be source, because it is not -uncommon for man pages to be automatically distributed. +uncommon for man pages to be automatically generated. @node Install @@ -2368,9 +2371,10 @@ The file @file{THANKS} is required. @node Cygnus @chapter The effect of @code{--cygnus} -Cygnus Support has slightly different rules for how a @file{Makefile.in} -is to be constructed. Passing @samp{--cygnus} to @code{automake} will -cause any generated @file{Makefile.in} to comply with Cygnus rules. +Cygnus Solutions has slightly different rules for how a +@file{Makefile.in} is to be constructed. Passing @samp{--cygnus} to +@code{automake} will cause any generated @file{Makefile.in} to comply +with Cygnus rules. Here are the precise effects of @samp{--cygnus}: diff --git a/stamp-vti b/stamp-vti index 0011e25a..22adba1e 100644 --- a/stamp-vti +++ b/stamp-vti @@ -1,3 +1,3 @@ -@set UPDATED 27 April 1997 +@set UPDATED 28 April 1997 @set EDITION 1.1o @set VERSION 1.1o diff --git a/version.texi b/version.texi index 0011e25a..22adba1e 100644 --- a/version.texi +++ b/version.texi @@ -1,3 +1,3 @@ -@set UPDATED 27 April 1997 +@set UPDATED 28 April 1997 @set EDITION 1.1o @set VERSION 1.1o -- 2.43.5