summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorobrien <obrien@FreeBSD.org>2003-03-02 02:51:40 +0000
committerobrien <obrien@FreeBSD.org>2003-03-02 02:51:40 +0000
commit867cf33fa04654ebba5e14e5d7dda8839f2bef40 (patch)
tree7cd10bcc003212f73f44fd85583c329cdaa5720d
parentf245ea0893dc7fbb32743636c5a017c5043e10e7 (diff)
downloadFreeBSD-src-867cf33fa04654ebba5e14e5d7dda8839f2bef40.zip
FreeBSD-src-867cf33fa04654ebba5e14e5d7dda8839f2bef40.tar.gz
Also allow and document a "build" ordering for variables.
Both "product" and "build" ordering are rampant in /usr/src. This document is not indented to be as strict as style(9) as historically BSD hasn't been as consistent about Makefile as C code. Also there are too many variations, exceptions and allowances in out existing Makefile style to be strict. However there is a general level of consensus on what the general BSD style of our Makefiles is. This manpage documents that "smell".
-rw-r--r--share/man/man5/style.Makefile.521
1 files changed, 20 insertions, 1 deletions
diff --git a/share/man/man5/style.Makefile.5 b/share/man/man5/style.Makefile.5
index 428f6f6..60292d0 100644
--- a/share/man/man5/style.Makefile.5
+++ b/share/man/man5/style.Makefile.5
@@ -64,7 +64,12 @@ Special variables (i.e.,
etc.) are listed in order of
.Dq product ,
then building and installing a binary.
-The general order is:
+It is also allowable to list special variables in
+.Dq build
+order: i.e., ones for the primary program (or library) first.
+The general
+.Dq product
+order is:
.Va PROG Ns / Ns Va LIB Ns / Ns Va SCRIPT
.Va FILES
.Va LINKS
@@ -76,6 +81,20 @@ The general order is:
.Va CFLAGS
.Va DPADD
.Va LDADD .
+The general
+.Dq build
+order is:
+.Va PROG Ns / Ns Va LIB Ns / Ns Va SCRIPT
+.Va SRCS
+.Va WARNS
+.Va CFLAGS
+.Va DPADD
+.Va LDADD
+.Va INCS
+.Va FILES
+.Va LINKS
+.Oo Va NO Oc Ns Va MAN
+.Va MLINKS.
.It
Omit
.Va SRCS
OpenPOWER on IntegriCloud