[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Patch: FYI: more doc updates
From: |
Tom Tromey |
Subject: |
Patch: FYI: more doc updates |
Date: |
30 Jul 2001 16:27:38 -0600 |
This is going in.
Tom
Index: ChangeLog
from Tom Tromey <address@hidden>
* automake.texi (Dist): Mention other distribution types.
(Install): Updates.
Index: automake.texi
===================================================================
RCS file: /cvs/automake/automake/automake.texi,v
retrieving revision 1.232
diff -u -r1.232 automake.texi
--- automake.texi 2001/07/29 17:51:41 1.232
+++ automake.texi 2001/07/30 21:57:09
@@ -3339,6 +3339,8 @@
@cindex Installation support
@cindex make install support
address@hidden Basics of installation
+
Naturally, Automake handles the details of actually installing your
program once it has been built. All files named by the various
primaries are automatically installed in the appropriate places when the
@@ -3368,27 +3370,22 @@
Will install @file{stdio.h} in @code{$(includedir)} and @file{types.h}
in @code{$(includedir)/sys}.
address@hidden The two parts of install
+
Automake generates separate @code{install-data} and @code{install-exec}
targets, in case the installer is installing on multiple machines which
share directory structure---these targets allow the machine-independent
-parts to be installed only once. The @code{install} target depends on
-both of these targets.
+parts to be installed only once. @code{install-exec} installs
+platform-dependent files, and @code{install-data} installs
+platform-independent files. The @code{install} target depends on both
+of these targets. While Automake tries to automatically segregate
+objects into the correct category, the @file{Makefile.am} author is, in
+the end, responsible for making sure this is done correctly.
@trindex install-data
@trindex install-exec
@trindex install
address@hidden Install, two parts of
-Automake also generates an @code{uninstall} target, an
address@hidden target, and an @code{install-strip} target.
address@hidden uninstall
address@hidden installdirs
address@hidden install-strip
-
-It is possible to extend this mechanism by defining an
address@hidden or @code{install-data-local} target. If these
-targets exist, they will be run at @samp{make install} time.
address@hidden install-exec-local
address@hidden install-data-local
-
Variables using the standard directory prefixes @samp{data},
@samp{info}, @samp{man}, @samp{include}, @samp{oldinclude},
@samp{pkgdata}, or @samp{pkginclude} (e.g. @samp{data_DATA}) are
@@ -3404,6 +3401,24 @@
@samp{install-exec}. All other user-defined prefixes are installed by
@samp{install-data}.
address@hidden Extending installation
+
+It is possible to extend this mechanism by defining an
address@hidden or @code{install-data-local} target. If these
+targets exist, they will be run at @samp{make install} time. These
+rules can do almost anything; care is required.
address@hidden install-exec-local
address@hidden install-data-local
+
+Automake also supports two install hooks, @code{install-exec-hook} and
address@hidden These hooks are run after all other install
+rules of the appropriate type, exec or data, have completed. So, for
+instance, it is possible to perform post-installation modifications
+using an install hook.
address@hidden Install hook
+
address@hidden Staged installs
+
@vindex DESTDIR
Automake generates support for the @samp{DESTDIR} variable in all
install rules. @samp{DESTDIR} is used during the @samp{make install}
@@ -3425,7 +3440,27 @@
more information, see @ref{Makefile Conventions, , , standards, The GNU
Coding Standards}.
+Support for @samp{DESTDIR} is implemented by coding it directly into the
+install rules. If your @file{Makefile.am} uses a local install rule
+(e.g., @code{install-exec-local}) or an install hook, then you must
+write that code to repsect @samp{DESTDIR}.
+
address@hidden Rules for the user
+
+Automake also generates an @code{uninstall} target, an
address@hidden target, and an @code{install-strip} target.
address@hidden uninstall
address@hidden installdirs
address@hidden install-strip
+
+Automake supports @code{uninstall-local} and @code{uninstall-hook}.
+There is no notion of separate uninstalls for ``exec'' and ``data'', as
+that does not make sense.
+Note that @code{uninstall} is not meant as a replacement for a real
+packaging tool.
+
+
@node Clean, Dist, Install, Top
@chapter What Gets Cleaned
@@ -3580,6 +3615,13 @@
anything, though as always caution is advised. Generally this hook is
used to check for potential distribution errors not caught by the
standard mechanism.
+
address@hidden The types of distributions
+
+By default Automake generates a @samp{.tar.gz} file when asked to create
+a distribution. However, some projects prefer different packaging
+formats. Automake accomodates most of these using options;
address@hidden
@node Tests, Options, Dist, Top
Index: stamp-vti
===================================================================
RCS file: /cvs/automake/automake/stamp-vti,v
retrieving revision 1.131
diff -u -r1.131 stamp-vti
--- stamp-vti 2001/07/29 17:51:41 1.131
+++ stamp-vti 2001/07/30 21:57:09
@@ -1,4 +1,4 @@
address@hidden UPDATED 29 July 2001
address@hidden UPDATED 30 July 2001
@set UPDATED-MONTH July 2001
@set EDITION 1.4i
@set VERSION 1.4i
Index: version.texi
===================================================================
RCS file: /cvs/automake/automake/version.texi,v
retrieving revision 1.204
diff -u -r1.204 version.texi
--- version.texi 2001/07/29 17:51:41 1.204
+++ version.texi 2001/07/30 21:57:09
@@ -1,4 +1,4 @@
address@hidden UPDATED 29 July 2001
address@hidden UPDATED 30 July 2001
@set UPDATED-MONTH July 2001
@set EDITION 1.4i
@set VERSION 1.4i
- Patch: FYI: more doc updates,
Tom Tromey <=