Document more SPECIAL SOURCES (aka ATTRIBUTES).

Improve description of variable modifiers.
In the variable list, be more specific referring to "environment variables"
rather than just relying upon the formatting difference between .Ev and .Va.
This commit is contained in:
lukem 2004-01-27 01:38:01 +00:00
parent 25d2de94fe
commit f83f942f81
1 changed files with 28 additions and 16 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: make.1,v 1.96 2003/12/26 23:22:31 wiz Exp $
.\" $NetBSD: make.1,v 1.97 2004/01/27 01:38:01 lukem 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 December 26, 2003
.Dd January 27, 2004
.Dt MAKE 1
.Os
.Sh NAME
@ -492,7 +492,7 @@ For compatibily
also sets
.Va .MAKE
with the same value.
The preferred variable to use is
The preferred variable to use is the environment variable
.Ev MAKE
because it is more compatible with other versions of
.Nm
@ -597,10 +597,10 @@ The general format of a variable expansion is as follows:
.Pp
.Dl {variable[:modifier[:...]]}
.Pp
Each modifier begins with a colon and one of the following
special characters.
The colon may be escaped with a backslash
Each modifier begins with a colon,
which may be escaped with a backslash
.Pq Ql \e .
The supported modifiers are:
.Bl -tag -width EEE
.It Cm \&:E
Replaces each word in the variable with its suffix.
@ -1205,12 +1205,18 @@ Comments begin with a hash
.Pq Ql \&#
character, anywhere but in a shell
command line, and continue to the end of the line.
.Sh SPECIAL SOURCES
.Sh SPECIAL SOURCES (ATTRIBUTES)
.Bl -tag -width .IGNOREx
.It Ic .EXEC
Target is never out of date, but always execute commands anyway.
.It Ic .IGNORE
Ignore any errors from the commands associated with this target, exactly
as if they all were preceded by a dash
.Pq Ql \- .
.\" .It Ic .INVISIBLE
.\" XXX
.\" .It Ic .JOIN
.\" XXX
.It Ic .MADE
Mark all sources of this target as being up-to-date.
.It Ic .MAKE
@ -1221,6 +1227,9 @@ or
options were specified.
Normally used to mark recursive
.Nm Ns 's .
.It Ic .NOPATH
Do not search for the target in the directories specified by
.Ic .PATH .
.It Ic .NOTMAIN
Normally
.Nm
@ -1232,11 +1241,20 @@ If a target is marked with this attribute and
.Nm
can't figure out how to create it, it will ignore this fact and assume
the file isn't needed or already exists.
.It Ic .PHONY
The target does not
correspond to an actual file; it is always considered to be out of date,
and will not be created with the
.Fl t
option.
.It Ic .PRECIOUS
When
.Nm
is interrupted, it removes any partially made targets.
This source prevents the target from being removed.
.It Ic .RECURSIVE
Synonym for
.Ic .MAKE .
.It Ic .SILENT
Do not echo any of the commands associated with this target, exactly
as if they all were preceded by an at sign
@ -1324,13 +1342,12 @@ no effect.
Apply the
.Ic .NOPATH
attribute to any specified sources.
Targets with this attribute are not
searched for in the directories specified by
.Ic .PATH .
.It Ic .NOTPARALLEL
Disable parallel mode.
.It Ic .NO_PARALLEL
Same as above, for compatibility with other pmake variants.
Synonym for
.Ic .NOTPARALLEL ,
for compatibility with other pmake variants.
.It Ic .ORDER
The named targets are made in sequence.
.\" XXX: NOT YET!!!!
@ -1351,11 +1368,6 @@ directory is searched last.
Apply the
.Ic .PHONY
attribute to any specified sources.
Targets with this attribute do not
correspond to actual files; they are always considered to be out of date,
and will not be created with the
.Fl t
option.
.It Ic .PRECIOUS
Apply the
.Ic .PRECIOUS