Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src/usr.bin/make make.1: use present tense in conditional sentences
details: https://anonhg.NetBSD.org/src/rev/428005199f60
branches: trunk
changeset: 369916:428005199f60
user: rillig <rillig%NetBSD.org@localhost>
date: Wed Sep 07 22:36:48 2022 +0000
description:
make.1: use present tense in conditional sentences
These sentences are about general, timeless rules, rather than about
predictions about the future.
diffstat:
usr.bin/make/make.1 | 173 ++++++++++++++++++++++++---------------------------
1 files changed, 81 insertions(+), 92 deletions(-)
diffs (truncated from 506 to 300 lines):
diff -r 7e2710485395 -r 428005199f60 usr.bin/make/make.1
--- a/usr.bin/make/make.1 Wed Sep 07 11:37:25 2022 +0000
+++ b/usr.bin/make/make.1 Wed Sep 07 22:36:48 2022 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: make.1,v 1.333 2022/09/05 17:13:36 rillig Exp $
+.\" $NetBSD: make.1,v 1.334 2022/09/07 22:36:48 rillig Exp $
.\"
.\" Copyright (c) 1990, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -29,7 +29,7 @@
.\"
.\" from: @(#)make.1 8.4 (Berkeley) 3/19/94
.\"
-.Dd September 2, 2022
+.Dd September 7, 2022
.Dt MAKE 1
.Os
.Sh NAME
@@ -106,10 +106,10 @@
.Nm
are to print debugging information.
Unless the flags are preceded by
-.Ql \-
+.Ql \- ,
they are added to the
.Ev MAKEFLAGS
-environment variable and will be processed by any child make processes.
+environment variable and are passed on to any child make processes.
By default, debugging information is printed to standard error,
but this can be changed using the
.Cm F
@@ -142,21 +142,21 @@
.Cm F
flag is
.Ql \&+ ,
-then the file will be opened in append mode;
-otherwise the file will be overwritten.
+then the file is opened in append mode;
+otherwise the file is overwritten.
If the file name is
.Ql stdout
or
-.Ql stderr
-then debugging output will be written to the
+.Ql stderr ,
+debugging output is written to the
standard output or standard error output file descriptors respectively
(and the
.Ql \&+
option has no effect).
-Otherwise, the output will be written to the named file.
+Otherwise, the output is written to the named file.
If the file name ends with
-.Ql .%d
-then the
+.Ql .%d ,
+the
.Ql %d
is replaced by the pid.
.It Cm f
@@ -174,9 +174,8 @@
Print debugging information about running multiple shells.
.It Cm L
Turn on lint checks.
-This will throw errors for variable assignments that do not parse
-correctly, at the time of assignment so the file and line number
-are available.
+This throws errors for variable assignments that do not parse correctly,
+at the time of assignment, so the file and line number are available.
.It Cm l
Print commands in Makefiles regardless of whether or not they are prefixed by
.Ql @
@@ -293,10 +292,9 @@
The
.Fl m
option can be used multiple times to form a search path.
-This path will override the default system include path
+This path overrides the default system include path
.Pa /usr/share/mk .
-Furthermore the system include path will be appended to the search path used
-for
+Furthermore the system include path is appended to the search path used for
.Li \*q Ns Ar file Ns Li \*q Ns -style
include statements (see the
.Fl I
@@ -307,14 +305,13 @@
argument (or the
.Ev MAKESYSPATH
environment variable) starts with the string
-.Ql \&.../
-then
+.Ql \&.../ ,
.Nm
-will search for the specified file or directory named in the remaining part
+searches for the specified file or directory named in the remaining part
of the argument string.
The search starts with the current directory of
the Makefile and then works upward towards the root of the file system.
-If the search is successful, then the resulting directory replaces the
+If the search is successful, the resulting directory replaces the
.Ql \&.../
specification in the
.Fl m
@@ -364,7 +361,7 @@
.Ar variable .
Do not build any targets.
Multiple instances of this option may be specified;
-the variables will be printed one per line,
+the variables are printed one per line,
with a blank line for each null or undefined variable.
The value printed is extracted from the global scope after all
makefiles have been read.
@@ -373,13 +370,12 @@
If
.Ar variable
contains a
-.Ql \&$
-then the value will be recursively expanded to its complete resultant
+.Ql \&$ ,
+the value is recursively expanded to its complete resultant
text before printing.
-The expanded value will also be printed if
+The expanded value is also printed if
.Va .MAKE.EXPAND_VARIABLES
-is set to true and
-the
+is set to true and the
.Fl dV
option has not been used to override it.
Note that loop-local and target-local variables, as well as values
@@ -442,7 +438,7 @@
and are customarily created from them.
A target is considered out-of-date if it does not exist, or if its
modification time is less than that of any of its sources.
-An out-of-date target will be re-created, but not until all sources
+An out-of-date target is re-created, but not until all sources
have been examined and themselves re-created as needed.
Three operators may be used:
.Bl -tag -width flag
@@ -471,7 +467,7 @@
commands are always run.
Also unlike
.Ic \&:,
-the target will not be removed if
+the target is not removed if
.Nm
is interrupted.
.El
@@ -548,19 +544,19 @@
single instance of the shell.
In compatibility (non-jobs) mode, each command is run in a separate process.
If the command contains any shell meta characters
-.Pq Ql #=|^(){};&<>*?[]:$`\e\en
-it will be passed to the shell; otherwise
+.Pq Ql #=|^(){};&<>*?[]:$`\e\en ,
+it is passed to the shell; otherwise
.Nm
-will attempt direct execution.
+attempts direct execution.
If a line starts with
.Sq Ic \-
-and the shell has ErrCtl enabled then failure of the command line
-will be ignored as in compatibility mode.
+and the shell has ErrCtl enabled, failure of the command line
+is ignored as in compatibility mode.
Otherwise
.Sq Ic \-
affects the entire job;
-the script will stop at the first command line that fails,
-but the target will not be deemed to have failed.
+the script stops at the first command line that fails,
+but the target is not deemed to have failed.
.Pp
Makefiles should be written so that the mode of
.Nm
@@ -588,12 +584,10 @@
.Pp
Since
.Nm
-will
-.Xr chdir 2
-to
+changes the current working directory to
.Sq Va .OBJDIR
-before executing any targets, each child process
-starts with that as its current working directory.
+before executing any targets,
+each child process starts with that as its current working directory.
.Sh VARIABLE ASSIGNMENTS
Variables in make behave much like macros in the C preprocessor.
.Pp
@@ -690,7 +684,7 @@
@echo ${b}
.Ed
.Pp
-will print:
+prints:
.Bd -literal -offset indent
1 2 3
3 3 3
@@ -732,7 +726,7 @@
is not set to
.Ql false .
The rest of the line
-(which will already have had global variables expanded)
+(which already has had global variables expanded)
is the variable value.
For example:
.Bd -literal -offset indent
@@ -743,10 +737,10 @@
.Pp
Only the targets
.Ql ${OBJS}
-will be impacted by that filter (in
+are impacted by that filter (in
.Dq meta
mode) and
-simply enabling/disabling any of the compiler wrappers will not render all
+simply enabling/disabling any of the compiler wrappers does not render all
of those targets out-of-date.
.Pp
.Em NOTE :
@@ -787,8 +781,8 @@
or preceding directory components; also known as
.Sq Va * .
The suffix must be one of the known suffixes declared with
-.Ic .SUFFIXES
-or it will not be recognized.
+.Ic .SUFFIXES ,
+or it is not recognized.
.It Va .TARGET
The name of the target; also known as
.Sq Va @ .
@@ -933,7 +927,7 @@
.Nm .
The initial instance of
.Nm
-will be 0, and an incremented value is put into the environment
+is 0, and an incremented value is put into the environment
to be seen by the next generation.
This allows tests like:
.Li .if ${.MAKE.LEVEL} == 0
@@ -946,7 +940,7 @@
.Sq Pa Makefile )
that
.Nm
-will look for.
+looks for.
.It Va .MAKE.MAKEFILES
The list of makefiles read by
.Nm ,
@@ -981,7 +975,7 @@
.It Pa curdirOk= Ar bf
Normally
.Nm
-will not create .meta files in
+does not create .meta files in
.Sq Va .CURDIR .
This can be overridden by setting
.Va bf
@@ -1040,7 +1034,7 @@
.Dq meta
mode, it can (very rarely!) be useful to filter command
lines before comparison.
-This variable can be set to a set of modifiers that will be applied to
+This variable can be set to a set of modifiers that are applied to
each line of the old and new command that differ, if the filtered
commands still differ, the target is considered out-of-date.
.It Va .MAKE.META.CREATED
@@ -1189,9 +1183,7 @@
.Sq Ic .OBJDIR .
In all cases,
.Nm
-will
-.Xr chdir 2
-to the specified directory if it exists, and set
+changes to the specified directory if it exists, and sets
.Sq Va .OBJDIR
and
.Sq Va PWD
@@ -1201,11 +1193,10 @@
.Sq Ic .OBJDIR
target,
.Nm
-will check that the specified directory is writable and ignore it if not.
+checks that the specified directory is writable and ignores it if not.
This check can be skipped by setting the environment variable
.Sq Ev MAKE_OBJDIR_CHECK_WRITABLE
to "no".
-.
.It Va .PARSEDIR
A path to the directory of the current
.Sq Pa Makefile
@@ -1225,7 +1216,7 @@
.It Va .PATH
A variable that represents the list of directories that
.Nm
-will search for files.
+searches for files.
The search list should be updated using the target
Home |
Main Index |
Thread Index |
Old Index