aboutsummaryrefslogtreecommitdiff
path: root/share
diff options
context:
space:
mode:
authorDavid E. O'Brien <obrien@FreeBSD.org>2003-03-02 02:40:38 +0000
committerDavid E. O'Brien <obrien@FreeBSD.org>2003-03-02 02:40:38 +0000
commita250a461709b786cbc73a6f5b94d7733248f59d7 (patch)
tree7978e6652d16e1c5a2b6d69faadf605329d60709 /share
parent1a3a935b84facfff43fecac8b44307e730e57531 (diff)
downloadsrc-a250a461709b786cbc73a6f5b94d7733248f59d7.tar.gz
src-a250a461709b786cbc73a6f5b94d7733248f59d7.zip
o Do not use VPATH.
o Give the proper spelling for WARNS. o Clarify using NO_WERROR. o Embelish -D after -I verbage. o Document preference of ${.ALLSRC} & ${.TARGET} vs. $< & $@. Based on: brucification
Notes
Notes: svn path=/head/; revision=111719
Diffstat (limited to 'share')
-rw-r--r--share/man/man5/style.Makefile.528
1 files changed, 27 insertions, 1 deletions
diff --git a/share/man/man5/style.Makefile.5 b/share/man/man5/style.Makefile.5
index 47e5305f6eb4..428f6f6478d6 100644
--- a/share/man/man5/style.Makefile.5
+++ b/share/man/man5/style.Makefile.5
@@ -55,6 +55,9 @@ comes next if needed, and is spelled
with a single
.Tn ASCII
space after a colon.
+Do not use the
+.Va VPATH
+variable.
.It
Special variables (i.e.,
.Va LIB , SRCS , MLINKS ,
@@ -118,12 +121,18 @@ so it does not get lost in a sea of
statements as
.Va WARNS
is an important thing.
+The usage of
+.Va WARNS
+is spelled
+.Dq Li "WARNS?= " .
+so that it may be overriden on the command-line or in
+.Pa /etc/make.conf .
.It
-Unconditional
.Dq Li "NO_WERROR= yes"
should not be used,
it defeats the purpose of
.Va WARNS .
+It should only be used on the command-line and in special circomstances.
.It
.Va CFLAGS
is spelled
@@ -144,6 +153,12 @@ often affect conditional compilation,
and
.Fl I Ns 's
tend to be quite long.
+Split long
+.Va CFLAGS
+settings between the
+.Fl D Ns 's
+and
+.Fl I Ns 's.
.It
Do not use GCCisms (such as
.Fl g
@@ -164,6 +179,17 @@ A lack of whitespace is also allowed for very long variable names.
.It
.Ic .include Aq Pa bsd.*.mk
goes last.
+.It
+Do not use anachronisms like
+.Va $<
+and
+.Va $@ .
+Instead use
+.Cm ${.IMPSRC}
+or
+.Cm ${.ALLSRC}
+and
+.Cm ${.TARGET}
.El
.Pp
The desire to express a logical grouping often means not obeying some of the