mirrors/make
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/make.git synced 2024-12-26 14:00:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

* doc/make.text: [SV 54360] Weaken "obsolete" language in the manual.

Browse source 
There's no need to frighten users away from capabilities which are
perfectly reasonable and definitely not going away, by calling them
obsolete or discouraged in the manual.
This commit is contained in:
Paul Smith 2018-09-09 15:58:13 -04:00
parent 67e6d81256
commit 92032bc16a
1 changed files with 24 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
doc/make.texi
View file

@ -4281,8 +4281,7 @@ remove a file.
When you run @code{make} with the @samp{-i} or @samp{--ignore-errors} When you run @code{make} with the @samp{-i} or @samp{--ignore-errors}
flag, errors are ignored in all recipes of all rules. A rule in the flag, errors are ignored in all recipes of all rules. A rule in the
makefile for the special target @code{.IGNORE} has the same effect, if makefile for the special target @code{.IGNORE} has the same effect, if
there are no prerequisites. These ways of ignoring errors are obsolete there are no prerequisites. This is less flexible but sometimes useful.
because @samp{-} is more flexible.
When errors are to be ignored, because of either a @samp{-} or the When errors are to be ignored, because of either a @samp{-} or the
@samp{-i} flag, @code{make} treats an error return just like success, @samp{-i} flag, @code{make} treats an error return just like success,
@ -5115,8 +5114,12 @@ this way!)
A dollar sign followed by a character other than a dollar sign, A dollar sign followed by a character other than a dollar sign,
open-parenthesis or open-brace treats that single character as the open-parenthesis or open-brace treats that single character as the
variable name. Thus, you could reference the variable @code{x} with variable name. Thus, you could reference the variable @code{x} with
@samp{$x}. However, this practice is strongly discouraged, except in @samp{$x}. However, this practice can lead to confusion (e.g.,
the case of the automatic variables (@pxref{Automatic Variables}). @samp{$foo} refers to the variable @code{f} followed by the string
@code{oo}) so we recommend using parentheses or braces around all
variables, even single-letter variables, unless omitting them gives
significant readability improvements. One place where readability is
often improved is automatic variables (@pxref{Automatic Variables}).
@node Flavors, Advanced, Reference, Using Variables @node Flavors, Advanced, Reference, Using Variables
@section The Two Flavors of Variables @section The Two Flavors of Variables
@ -9972,15 +9975,15 @@ lib: foo.o bar.o lose.o win.o
@end example @end example
Of the variables listed above, four have values that are single file Of the variables listed above, four have values that are single file
names, and three have values that are lists of file names. These seven names, and three have values that are lists of file names. These
have variants that get just the file's directory name or just the file seven have variants that get just the file's directory name or just
name within the directory. The variant variables' names are formed by the file name within the directory. The variant variables' names are
appending @samp{D} or @samp{F}, respectively. These variants are formed by appending @samp{D} or @samp{F}, respectively. The functions
semi-obsolete in GNU @code{make} since the functions @code{dir} and @code{dir} and @code{notdir} can be used to obtain a similar effect
@code{notdir} can be used to get a similar effect (@pxref{File Name (@pxref{File Name Functions, , Functions for File Names}). Note,
Functions, , Functions for File Names}). Note, however, that the however, that the @samp{D} variants all omit the trailing slash which
@samp{D} variants all omit the trailing slash which always appears in always appears in the output of the @code{dir} function. Here is a
the output of the @code{dir} function. Here is a table of the variants: table of the variants:
@table @samp @table @samp
@vindex $(@@D) @vindex $(@@D)
@ -10297,12 +10300,13 @@ general and clearer. They are supported in GNU @code{make} for
compatibility with old makefiles. They come in two kinds: compatibility with old makefiles. They come in two kinds:
@dfn{double-suffix} and @dfn{single-suffix}.@refill @dfn{double-suffix} and @dfn{single-suffix}.@refill
A double-suffix rule is defined by a pair of suffixes: the target suffix A double-suffix rule is defined by a pair of suffixes: the target
and the source suffix. It matches any file whose name ends with the suffix and the source suffix. It matches any file whose name ends
target suffix. The corresponding implicit prerequisite is made by with the target suffix. The corresponding implicit prerequisite is
replacing the target suffix with the source suffix in the file name. A made by replacing the target suffix with the source suffix in the file
two-suffix rule whose target and source suffixes are @samp{.o} and name. A two-suffix rule @samp{.c.o} (whose target and source suffixes
@samp{.c} is equivalent to the pattern rule @samp{%.o : %.c}. are @samp{.o} and @samp{.c}) is equivalent to the pattern rule
@samp{%.o : %.c}.
A single-suffix rule is defined by a single suffix, which is the source A single-suffix rule is defined by a single suffix, which is the source
suffix. It matches any file name, and the corresponding implicit suffix. It matches any file name, and the corresponding implicit
@ -11883,7 +11887,7 @@ In System V and 4.3 BSD @code{make}, files found by @code{VPATH}
search (@pxref{Directory Search, ,Searching Directories for search (@pxref{Directory Search, ,Searching Directories for
Prerequisites}) have their names changed inside recipes. We feel it Prerequisites}) have their names changed inside recipes. We feel it
is much cleaner to always use automatic variables and thus make this is much cleaner to always use automatic variables and thus make this
feature obsolete.@refill feature unnecessary.@refill
@item @item
In some Unix @code{make}s, the automatic variable @code{$*} appearing in In some Unix @code{make}s, the automatic variable @code{$*} appearing in