summaryrefslogtreecommitdiff
path: root/doc/make-stds.texi
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2006-07-10 13:16:09 +0000
committerKarl Berry <karl@freefriends.org>2006-07-10 13:16:09 +0000
commit0ba427b5dc14eab9c5aeb8e2e107569827b41b78 (patch)
tree2da48c5b66539a4a8467e8e8d1fc0f10417fac01 /doc/make-stds.texi
parente198412802cd9796992efdac69c3590958bde1be (diff)
downloadgnulib-0ba427b5dc14eab9c5aeb8e2e107569827b41b78.tar.gz
autoupdate
Diffstat (limited to 'doc/make-stds.texi')
-rw-r--r--doc/make-stds.texi39
1 files changed, 22 insertions, 17 deletions
diff --git a/doc/make-stds.texi b/doc/make-stds.texi
index f306751090..8e8d65e09b 100644
--- a/doc/make-stds.texi
+++ b/doc/make-stds.texi
@@ -264,7 +264,7 @@ Every Makefile should also define the variables @code{INSTALL_PROGRAM}
and @code{INSTALL_DATA}. (The default for @code{INSTALL_PROGRAM} should
be @code{$(INSTALL)}; the default for @code{INSTALL_DATA} should be
@code{$@{INSTALL@} -m 644}.) Then it should use those variables as the
-commands for actual installation, for executables and nonexecutables
+commands for actual installation, for executables and non-executables
respectively. Minimal use of these variables is as follows:
@example
@@ -305,9 +305,9 @@ make DESTDIR=/tmp/stage install
@end example
@noindent
-Since the value of @code{DESTDIR} is only used during installation, it
-should only be supported in the @code{install*} and @code{uninstall*}
-targets.
+@code{DESTDIR} should be supported only in the @code{install*} and
+@code{uninstall*} targets, as those are the only targets where it is
+useful.
If your installation step would normally install
@file{/usr/local/bin/foo} and @file{/usr/local/lib/libfoo.a}, then an
@@ -335,8 +335,8 @@ to install into protected areas to build and install before gaining
those permissions. Finally, it can be useful with tools such as
@code{stow}, where code is installed in one place but made to appear
to be installed somewhere else using symbolic links or special mount
-operations. So, we recommend GNU packages support @code{DESTDIR},
-though it is not an absolute requirement.
+operations. So, we strongly recommend GNU packages support
+@code{DESTDIR}, though it is not an absolute requirement.
@node Directory Variables
@@ -642,7 +642,7 @@ And finally, you should set the following variable:
@item srcdir
The directory for the sources being compiled. The value of this
variable is normally inserted by the @code{configure} shell script.
-(If you are using Autconf, use @samp{srcdir = @@srcdir@@}.)
+(If you are using Autoconf, use @samp{srcdir = @@srcdir@@}.)
@end table
For example:
@@ -676,13 +676,13 @@ specify the exact same values for several different GNU packages. In
order for this to be useful, all the packages must be designed so that
they will work sensibly when the user does so.
-Not all of these variables may be implemented in the current release
-of Autoconf and/or Automake; right now, that includes at least
-@code{docdir}, @code{psdir}, @code{pdfdir}, @code{htmldir},
-@code{dvidir}. In these cases, the descriptions here serve as
-specifications for what Autoconf will implement. As a programmer, you
-can either use a development version of Autoconf or avoid using these
-variables until a stable release is made which supports them.
+At times, not all of these variables may be implemented in the current
+release of Autoconf and/or Automake; but as of Autoconf@tie{}2.60, we
+believe all of them are. When any are missing, the descriptions here
+serve as specifications for what Autoconf will implement. As a
+programmer, you can either use a development version of Autoconf or
+avoid using these variables until a stable release is made which
+supports them.
@node Standard Targets
@@ -778,8 +778,9 @@ manuals, and you wish to install HTML documentation with many files
certainly want to use subdirectories, or two nodes with the same name
in different manuals will overwrite each other.
-Please make these @code{install-@var{format}} targets depend on the
-correspond @var{format} target.
+Please make these @code{install-@var{format}} targets invoke the
+commands for the @var{format} target, for example, by making
+@var{format} a dependency.
@item uninstall
Delete all the installed files---the copies that the @samp{install}
@@ -906,7 +907,11 @@ because they will already be up to date.
@itemx html
@itemx pdf
@itemx ps
-Generate documentation files in the given format, if possible.
+Generate documentation files in the given format. These targets
+should always exist, but any or all can be a no-op if the given output
+format cannot be generated. These targets should not be dependencies
+of the @code{all} target; the user must manually invoke them.
+
Here's an example rule for generating DVI files from Texinfo:
@smallexample