From: Alexandre Duret-Lutz Date: Thu, 27 Nov 2003 21:46:13 +0000 (+0000) Subject: * doc/automake.texi: More target vs. rule editing. Back out some X-Git-Tag: Release-1-7h~8 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2e3bd8433ea520d381c687775919753ddd020cd7;p=thirdparty%2Fautomake.git * doc/automake.texi: More target vs. rule editing. Back out some of the previous changes. It's OK to talk about targets as "entry points", or as thing to build, but targets cannot be run: rules are run. --- diff --git a/ChangeLog b/ChangeLog index 83aba3fb7..112f9ed7f 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ 2003-11-27 Alexandre Duret-Lutz + * doc/automake.texi: More target vs. rule editing. Back out some + of the previous changes. It's OK to talk about targets as "entry + points", or as thing to build, but targets cannot be run: rules + are run. + * doc/automake.texi: s/target/rule/ where appropriate. A target is the destination of a target rule, not the rule itself. Suggested by Bruno Haible. diff --git a/doc/automake.texi b/doc/automake.texi index 996d3190d..4f19f1165 100644 --- a/doc/automake.texi +++ b/doc/automake.texi @@ -4244,10 +4244,10 @@ make: *** [foo.o] Error 1 @unnumberedsubsec Recording dependencies manually Usually people are happy enough with @code{BUILT_SOURCES} because they -never run rules such as @code{make foo} before @code{make all}, as in -the previous example. However if this matters to you, you can avoid -@code{BUILT_SOURCES} and record such dependencies explicitly in the -@file{Makefile.am}. +never build targets such as @code{make foo} before @code{make all}, as +in the previous example. However if this matters to you, you can +avoid @code{BUILT_SOURCES} and record such dependencies explicitly in +the @file{Makefile.am}. @example bin_PROGRAMS = foo @@ -4711,8 +4711,8 @@ requirement for @file{texinfo.tex}. Use of the variable @cindex Rule, noinstall-info @cindex Target, install-info @cindex Target, noinstall-info -@cindex install-info rule -@cindex noinstall-info rule +@cindex install-info target +@cindex noinstall-info target @opindex no-installinfo @trindex install-info @@ -4829,8 +4829,8 @@ installed, but the other files will keep their names. @cindex Rule, noinstall-man @cindex Target, install-man @cindex Target, noinstall-man -@cindex install-man rule -@cindex noinstall-man rule +@cindex install-man target +@cindex noinstall-man target @c Use @samp{make install} per documentation: (texi)code. By default, man pages are installed by @samp{make install}. However, @@ -5380,9 +5380,9 @@ In either case, the testing is done via @samp{make check}. @section Install Tests -The @code{installcheck} rule is available to the user as a way to run -any tests after the package has been installed. You can add tests to -this by writing an @code{installcheck-local} rule. +The @code{installcheck} target is available to the user as a way to +run any tests after the package has been installed. You can add tests +to this by writing an @code{installcheck-local} rule. @node Options @@ -5463,7 +5463,7 @@ case the effect is to effectively disable automatic dependency tracking. @item @code{no-dist} @cindex Option, no-dist -Don't emit any code related to @code{dist} rule. This is useful +Don't emit any code related to @code{dist} target. This is useful when a package has its own method for making distributions. @item @code{no-dist-gzip} @@ -5486,7 +5486,7 @@ executables. @cindex Option, no-installinfo The generated @file{Makefile.in} will not cause info pages to be built or installed by default. However, @code{info} and @code{install-info} -rules will still be available. This option is disallowed at +targets will still be available. This option is disallowed at @samp{GNU} strictness and above. @trindex info @trindex install-info @@ -5494,7 +5494,7 @@ rules will still be available. This option is disallowed at @item @code{no-installman} @cindex Option, no-installman The generated @file{Makefile.in} will not cause man pages to be -installed by default. However, an @code{install-man} rule will still +installed by default. However, an @code{install-man} target will still be available for optional installation. This option is disallowed at @samp{GNU} strictness and above. @trindex install-man @@ -5600,16 +5600,15 @@ If any C, C++ or Fortran 77 source code or headers are present, then @trindex tags At the topmost directory of a multi-directory package, a @code{tags} -file will be generated which, when run, will generate a -@file{TAGS} file that includes by reference all @file{TAGS} files from -subdirectories. +rule will be output which, when run, will generate a @file{TAGS} file +that includes by reference all @file{TAGS} files from subdirectories. -The @code{tags} file will also be generated if the variable +The @code{tags} rule will also be generated if the variable @code{ETAGS_ARGS} is defined. This variable is intended for use in directories which contain taggable source that @code{etags} does not understand. The user can use the @code{ETAGSFLAGS} to pass additional -flags to @code{etags}; @code{AM_ETAGSFLAGS} is also available for use in -@file{Makefile.am}. +flags to @code{etags}; @code{AM_ETAGSFLAGS} is also available for use +in @file{Makefile.am}. @vindex ETAGS_ARGS @vindex ETAGSFLAGS @vindex AM_ETAGSFLAGS @@ -5944,7 +5943,7 @@ The macros @samp{AM_MAINTAINER_MODE} and @samp{AM_CYGWIN32} are required. @item -The @code{check} rule doesn't depend on @code{all}. +The @code{check} target doesn't depend on @code{all}. @end itemize GNU maintainers are advised to use @samp{gnu} strictness in preference @@ -6168,7 +6167,7 @@ older than the requested version. @heading What is in the API Automake's programming interface is not easy to define. Basically it -should include at least all @strong{documented} variables and rules +should include at least all @strong{documented} variables and targets that a @samp{Makefile.am} author can use, any behavior associated with them (e.g. the places where @samp{-hook}'s are run), the command line interface of @samp{automake} and @samp{aclocal}, @dots{} @@ -6322,8 +6321,8 @@ tree, @file{Makefile.in} will happen to be newer than @subsubheading Generated files out of CVS One way to get CVS and @code{make} working peacefully is to never -store generated files in CVS, i.e., do not CVS-control files which are -@code{Makefile} rules (or @emph{derived} files in Make terminology). +store generated files in CVS, i.e., do not CVS-controled files which +are @code{Makefile} targets (also called @emph{derived} files). This way developers are not annoyed by changes to generated files. It does not matter if they all have different versions (assuming they are