changeset 12192:b0d3e25d7cdc

doc: regenerate INSTALL * doc/INSTALL: Reflect recent autoconf update. * doc/INSTALL.ISO: Likewise. * doc/INSTALL.UTF-8: Likewise. Signed-off-by: Eric Blake <ebb9@byu.net>
author Eric Blake <ebb9@byu.net>
date Tue, 20 Oct 2009 20:27:20 -0600
parents b2fed9c70341
children d1ea4269ac6f
files ChangeLog doc/INSTALL doc/INSTALL.ISO doc/INSTALL.UTF-8
diffstat 4 files changed, 64 insertions(+), 54 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2009-10-20  Eric Blake  <ebb9@byu.net>
+
+	doc: regenerate INSTALL
+	* doc/INSTALL: Reflect recent autoconf update.
+	* doc/INSTALL.ISO: Likewise.
+	* doc/INSTALL.UTF-8: Likewise.
+
 2009-10-20  Pádraig Brady  <P@draigBrady.com>
 
 	acl: warn if ACL support is not detected
--- a/doc/INSTALL
+++ b/doc/INSTALL
@@ -69,6 +69,10 @@
 
   5. Optionally, type `make installcheck' to repeat any self-tests, but
      this time using the binaries in their final installed location.
+     This target does not install anything.  Running this target as a
+     regular user, particularly if the prior `make install' required
+     root privileges, verifies that the installation completed
+     correctly.
 
   6. You can remove the program binaries and object files from the
      source code directory by typing `make clean'.  To also remove the
@@ -141,7 +145,7 @@
 `/usr/local/bin', include files under `/usr/local/include', etc.  You
 can specify an installation prefix other than `/usr/local' by giving
 `configure' the option `--prefix=PREFIX', where PREFIX must be an
-absolute path.
+absolute file name.
 
    You can specify separate installation prefixes for
 architecture-specific files and architecture-independent files.  If you
@@ -155,7 +159,7 @@
 you can set and what kinds of files go in them.  In general, the
 default for these options is expressed in terms of `${prefix}', so that
 specifying just `--prefix' will affect all of the other directory
-specifications.
+specifications that were not explicitly provided.
 
    The most portable way to affect installation locations is to pass the
 correct locations to `configure'; however, many packages provide one or
@@ -165,28 +169,25 @@
 
    The first method involves providing an override variable for each
 affected directory.  For example, `make install
-prefix=/path/to/alternate' will choose an alternate location, as well as
-influencing all other directory configuration variables that were
-expressed in terms of `${prefix}' (or, put another way, all directories
-specified during `configure' but not in terms of the common prefix must
-each be overridden at install time for the entire installation to be
-relocated).  The approach of makefile variable overrides for each
-directory variable is required by the GNU Coding Standards, and ideally
-causes no recompilation.  However, some platforms have known
-limitations with the semantics of shared libraries that end up
-requiring recompilation when using this method, particularly noticeable
-in packages that use GNU Libtool.
+prefix=/alternate/directory' will choose an alternate location for all
+directory configuration variables that were expressed in terms of
+`${prefix}'.  Any directories that were specified during `configure',
+but not in terms of `${prefix}', must each be overridden at install
+time for the entire installation to be relocated.  The approach of
+makefile variable overrides for each directory variable is required by
+the GNU Coding Standards, and ideally causes no recompilation.
+However, some platforms have known limitations with the semantics of
+shared libraries that end up requiring recompilation when using this
+method, particularly noticeable in packages that use GNU Libtool.
 
    The second method involves providing the `DESTDIR' variable.  For
-example, `make install DESTDIR=/path/to/alternate' will prepend
-`/path/to/alternate' before all installation paths.  The approach of
+example, `make install DESTDIR=/alternate/directory' will prepend
+`/alternate/directory' before all installation names.  The approach of
 `DESTDIR' overrides is not required by the GNU Coding Standards, and
 does not work on platforms that have drive letters.  On the other hand,
 it does better at avoiding recompilation issues, and works well even
 when some directory options were not specified in terms of `${prefix}'
-at `configure' time.  For packages which support `DESTDIR', the
-variable should remain undefined during `configure' and `make all', and
-only be specified during `make install'.
+at `configure' time.
 
 Optional Features
 =================
--- a/doc/INSTALL.ISO
+++ b/doc/INSTALL.ISO
@@ -69,6 +69,10 @@
 
   5. Optionally, type 'make installcheck' to repeat any self-tests, but
      this time using the binaries in their final installed location.
+     This target does not install anything.  Running this target as a
+     regular user, particularly if the prior 'make install' required
+     root privileges, verifies that the installation completed
+     correctly.
 
   6. You can remove the program binaries and object files from the
      source code directory by typing 'make clean'.  To also remove the
@@ -141,7 +145,7 @@
 '/usr/local/bin', include files under '/usr/local/include', etc.  You
 can specify an installation prefix other than '/usr/local' by giving
 'configure' the option '--prefix=PREFIX', where PREFIX must be an
-absolute path.
+absolute file name.
 
    You can specify separate installation prefixes for
 architecture-specific files and architecture-independent files.  If you
@@ -155,7 +159,7 @@
 you can set and what kinds of files go in them.  In general, the
 default for these options is expressed in terms of '${prefix}', so that
 specifying just '--prefix' will affect all of the other directory
-specifications.
+specifications that were not explicitly provided.
 
    The most portable way to affect installation locations is to pass the
 correct locations to 'configure'; however, many packages provide one or
@@ -165,28 +169,25 @@
 
    The first method involves providing an override variable for each
 affected directory.  For example, `make install
-prefix=/path/to/alternate' will choose an alternate location, as well as
-influencing all other directory configuration variables that were
-expressed in terms of '${prefix}' (or, put another way, all directories
-specified during 'configure' but not in terms of the common prefix must
-each be overridden at install time for the entire installation to be
-relocated).  The approach of makefile variable overrides for each
-directory variable is required by the GNU Coding Standards, and ideally
-causes no recompilation.  However, some platforms have known
-limitations with the semantics of shared libraries that end up
-requiring recompilation when using this method, particularly noticeable
-in packages that use GNU Libtool.
+prefix=/alternate/directory' will choose an alternate location for all
+directory configuration variables that were expressed in terms of
+'${prefix}'.  Any directories that were specified during 'configure',
+but not in terms of '${prefix}', must each be overridden at install
+time for the entire installation to be relocated.  The approach of
+makefile variable overrides for each directory variable is required by
+the GNU Coding Standards, and ideally causes no recompilation.
+However, some platforms have known limitations with the semantics of
+shared libraries that end up requiring recompilation when using this
+method, particularly noticeable in packages that use GNU Libtool.
 
    The second method involves providing the 'DESTDIR' variable.  For
-example, 'make install DESTDIR=/path/to/alternate' will prepend
-'/path/to/alternate' before all installation paths.  The approach of
+example, 'make install DESTDIR=/alternate/directory' will prepend
+'/alternate/directory' before all installation names.  The approach of
 'DESTDIR' overrides is not required by the GNU Coding Standards, and
 does not work on platforms that have drive letters.  On the other hand,
 it does better at avoiding recompilation issues, and works well even
 when some directory options were not specified in terms of '${prefix}'
-at 'configure' time.  For packages which support 'DESTDIR', the
-variable should remain undefined during 'configure' and 'make all', and
-only be specified during 'make install'.
+at 'configure' time.
 
 Optional Features
 =================
--- a/doc/INSTALL.UTF-8
+++ b/doc/INSTALL.UTF-8
@@ -69,6 +69,10 @@
 
   5. Optionally, type ‘make installcheck’ to repeat any self-tests, but
      this time using the binaries in their final installed location.
+     This target does not install anything.  Running this target as a
+     regular user, particularly if the prior ‘make install’ required
+     root privileges, verifies that the installation completed
+     correctly.
 
   6. You can remove the program binaries and object files from the
      source code directory by typing ‘make clean’.  To also remove the
@@ -141,7 +145,7 @@
 ‘/usr/local/bin’, include files under ‘/usr/local/include’, etc.  You
 can specify an installation prefix other than ‘/usr/local’ by giving
 ‘configure’ the option ‘--prefix=PREFIX’, where PREFIX must be an
-absolute path.
+absolute file name.
 
    You can specify separate installation prefixes for
 architecture-specific files and architecture-independent files.  If you
@@ -155,7 +159,7 @@
 you can set and what kinds of files go in them.  In general, the
 default for these options is expressed in terms of ‘${prefix}’, so that
 specifying just ‘--prefix’ will affect all of the other directory
-specifications.
+specifications that were not explicitly provided.
 
    The most portable way to affect installation locations is to pass the
 correct locations to ‘configure’; however, many packages provide one or
@@ -165,28 +169,25 @@
 
    The first method involves providing an override variable for each
 affected directory.  For example, `make install
-prefix=/path/to/alternate' will choose an alternate location, as well as
-influencing all other directory configuration variables that were
-expressed in terms of ‘${prefix}’ (or, put another way, all directories
-specified during ‘configure’ but not in terms of the common prefix must
-each be overridden at install time for the entire installation to be
-relocated).  The approach of makefile variable overrides for each
-directory variable is required by the GNU Coding Standards, and ideally
-causes no recompilation.  However, some platforms have known
-limitations with the semantics of shared libraries that end up
-requiring recompilation when using this method, particularly noticeable
-in packages that use GNU Libtool.
+prefix=/alternate/directory' will choose an alternate location for all
+directory configuration variables that were expressed in terms of
+‘${prefix}’.  Any directories that were specified during ‘configure’,
+but not in terms of ‘${prefix}’, must each be overridden at install
+time for the entire installation to be relocated.  The approach of
+makefile variable overrides for each directory variable is required by
+the GNU Coding Standards, and ideally causes no recompilation.
+However, some platforms have known limitations with the semantics of
+shared libraries that end up requiring recompilation when using this
+method, particularly noticeable in packages that use GNU Libtool.
 
    The second method involves providing the ‘DESTDIR’ variable.  For
-example, ‘make install DESTDIR=/path/to/alternate’ will prepend
-‘/path/to/alternate’ before all installation paths.  The approach of
+example, ‘make install DESTDIR=/alternate/directory’ will prepend
+‘/alternate/directory’ before all installation names.  The approach of
 ‘DESTDIR’ overrides is not required by the GNU Coding Standards, and
 does not work on platforms that have drive letters.  On the other hand,
 it does better at avoiding recompilation issues, and works well even
 when some directory options were not specified in terms of ‘${prefix}’
-at ‘configure’ time.  For packages which support ‘DESTDIR’, the
-variable should remain undefined during ‘configure’ and ‘make all’, and
-only be specified during ‘make install’.
+at ‘configure’ time.
 
 Optional Features
 =================