X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;f=doc%2Fmake-stds.texi;h=7cc9537b828cc8b3713615470f5fb66777e430ff;hb=4f2ec69bf1dbf08065d2e248f4fcee2a52f52675;hp=5ccde9e3d13c4d5e8a36da698ea8ee60d5896b9f;hpb=106d3ad905054693a6e424305167452bbaa49f87;p=gnulib.git diff --git a/doc/make-stds.texi b/doc/make-stds.texi index 5ccde9e3d..7cc9537b8 100644 --- a/doc/make-stds.texi +++ b/doc/make-stds.texi @@ -3,14 +3,13 @@ @node Makefile Conventions @chapter Makefile Conventions -@comment standards.texi does not print an index, but make.texinfo does. @cindex makefile, conventions for @cindex conventions for makefiles @cindex standards for makefiles -@c Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000, 2001, -@c 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. - +@c Copyright 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000, 2001, +@c 2004, 2005, 2006, 2007, 2008, 2010 Free Software Foundation, Inc. +@c @c Permission is granted to copy, distribute and/or modify this document @c under the terms of the GNU Free Documentation License, Version 1.3 @c or any later version published by the Free Software Foundation; @@ -91,7 +90,7 @@ to @file{configure}. A rule of the form: @smallexample foo.1 : foo.man sedscript - sed -e sedscript foo.man > foo.1 + sed -f sedscript foo.man > foo.1 @end smallexample @noindent @@ -125,7 +124,7 @@ way to make the rule work well. For example, the target above for @smallexample foo.1 : foo.man sedscript - sed -e $(srcdir)/sedscript $(srcdir)/foo.man > $@@ + sed -f $(srcdir)/sedscript $(srcdir)/foo.man > $@@ @end smallexample GNU distributions usually contain some files which are not source @@ -160,8 +159,8 @@ installation should not use any utilities directly except these: @c mkfifo mknod tee uname @example -awk cat cmp cp diff echo egrep expr false grep install-info -ln ls mkdir mv pwd rm rmdir sed sleep sort tar test touch true +awk cat cmp cp diff echo egrep expr false grep install-info ln ls +mkdir mv printf pwd rm rmdir sed sleep sort tar test touch tr true @end example Compression programs such as @code{gzip} can be used in the @@ -294,7 +293,7 @@ $(INSTALL_PROGRAM) foo bar baz $(bindir) @node DESTDIR -@section @code{DESTDIR}: support for staged installs +@section @code{DESTDIR}: Support for Staged Installs @vindex DESTDIR @cindex staged installs @@ -321,7 +320,7 @@ make DESTDIR=/tmp/stage install useful. If your installation step would normally install -@file{/usr/local/bin/foo} and @file{/usr/local/lib/libfoo.a}, then an +@file{/usr/local/bin/foo} and @file{/usr/@/local/@/lib/@/libfoo.a}, then an installation invoked as in the example above would install @file{/tmp/stage/usr/local/bin/foo} and @file{/tmp/stage/usr/local/lib/libfoo.a} instead. @@ -368,6 +367,11 @@ these variables on the system they are being installed onto: use the default settings specified here so that all GNU packages behave identically, allowing the installer to achieve any desired layout. +@cindex directories, creating installation +@cindex installation directories, creating +All installation directories, and their parent directories, should be +created (if necessary) before they are installed into. + These first two variables set the root for the installation. All the other installation directories should be subdirectories of one of these two, and nothing should be directly installed into these two @@ -474,9 +478,11 @@ the same place as @samp{datarootdir}, but we use the two separate variables so that you can move these program-specific files without altering the location for Info files, man pages, etc. +@c raggedright (not until next Texinfo release) This should normally be @file{/usr/local/share}, but write it as @file{$(datarootdir)}. (If you are using Autoconf, write it as @samp{@@datadir@@}.) +@c end raggedright The definition of @samp{datadir} is the same for all packages, so you should install your data in a subdirectory thereof. Most packages @@ -521,7 +527,6 @@ need @samp{libdir} or @samp{lispdir}. @table @samp @item includedir -@c rewritten to avoid overfull hbox --roland The directory for installing header files to be included by user programs with the C @samp{#include} preprocessor directive. This should normally be @file{/usr/local/include}, but write it as @@ -743,26 +748,31 @@ with @code{$(INSTALL_DATA)} (@pxref{Command Variables}), and then run the @code{install-info} program if it is present. @code{install-info} is a program that edits the Info @file{dir} file to add or update the menu entry for the given Info file; it is part of the Texinfo package. -Here is a sample rule to install an Info file: + +Here is a sample rule to install an Info file that also tries to +handle some additional situations, such as @code{install-info} not +being present. @comment This example has been carefully formatted for the Make manual. @comment Please do not reformat it without talking to bug-make@gnu.org. @smallexample -$(DESTDIR)$(infodir)/foo.info: foo.info - $(POST_INSTALL) -# There may be a newer info file in . than in srcdir. - -if test -f foo.info; then d=.; \ - else d=$(srcdir); fi; \ - $(INSTALL_DATA) $$d/foo.info $(DESTDIR)$@@; \ +do-install-info: foo.info installdirs + $(NORMAL_INSTALL) +# Prefer an info file in . to one in srcdir. + if test -f foo.info; then d=.; \ + else d="$(srcdir)"; fi; \ + $(INSTALL_DATA) $$d/foo.info \ + "$(DESTDIR)$(infodir)/foo.info" # Run install-info only if it exists. # Use `if' instead of just prepending `-' to the # line so we notice real errors from install-info. -# We use `$(SHELL) -c' because some shells do not +# Use `$(SHELL) -c' because some shells do not # fail gracefully when there is an unknown command. + $(POST_INSTALL) if $(SHELL) -c 'install-info --version' \ >/dev/null 2>&1; then \ - install-info --dir-file=$(DESTDIR)$(infodir)/dir \ - $(DESTDIR)$(infodir)/foo.info; \ + install-info --dir-file="$(DESTDIR)$(infodir)/dir" \ + "$(DESTDIR)$(infodir)/foo.info"; \ else true; fi @end smallexample @@ -968,8 +978,7 @@ then @code{tar} that subdirectory. Compress the tar file with @code{gzip}. For example, the actual distribution file for GCC version 1.40 is called @file{gcc-1.40.tar.gz}. -It is ok to support other free compression formats as well, such as -@code{bzip2} and @code{lzma}. +It is ok to support other free compression formats as well. The @code{dist} target should explicitly depend on all non-source files that are in the distribution, to make sure they are up to date in the @@ -1001,8 +1010,7 @@ the program before running the tests. You should not assume that It's useful to add a target named @samp{installdirs} to create the directories where files are installed, and their parent directories. There is a script called @file{mkinstalldirs} which is convenient for -this; you can find it in the Texinfo package. -@c It's in /gd/gnu/lib/mkinstalldirs. +this; you can find it in the Gnulib package. You can use a rule like this: @comment This has been carefully formatted to look decent in the Make manual. @@ -1017,7 +1025,7 @@ installdirs: mkinstalldirs @end smallexample @noindent -or, if you wish to support @env{DESTDIR}, +or, if you wish to support @env{DESTDIR} (strongly encouraged), @smallexample # Make sure all installation directories (e.g. $(bindir))