style.Makefile(5) manページ

このファイルは FreeBSD ソースツリーの makefile に好ましいスタイルを明記しています。

全ての makefile はファイルの先頭に SCM ID を持ち、それに空行が続きます。
```
# $FreeBSDamp;$
```
必要ならば、次に .PATH: が続きます。 ".PATH: " のように、コロンの後に単一の アスキー スペースが続くように綴ります。 VPATH 変数は使わないでください。
特殊変数 ( LIB 、 SRCS 、 MLINKS など) は、作成されるもの、バイナリの構築に使うもの、バイナリのインストールに使うものの順番で並べます (「作成物順」)。あるいは構築される順番、つまり主となるプログラム (あるいはライブラリ) に使うものが先にくるように並べても構いません (「構築物順」)。一般的な「作成物順」はこうです: PROG/[ ] LIB/ SCRIPTS FILES LINKS [ NO ] MAN MLINKS INCS SRCS WARNS CFLAGS DPADD LDADD 。一般的な「構築物順」はこうです: PROG/[ ] LIB/ SCRIPTS SRCS WARNS CFLAGS DPADD LDADD INCS FILES LINKS [ NO ] MAN MLINKS 。
<bsd.prog.mk> を使い、 PROG と同じ名前の単一のソースファイルである場合は、 SRCS を省略します。
<bsd.prog.mk> を使い、 PROG と同じ名前で、セクション 1 のマニュアルページである時は、 MAN を省略します。
変数への代入はすべて " VAR =" のように綴ります。つまり、変数名と = の間には空白を置きません。可能ならば、値はアルファベット順にソートするようにします。
変数を一回だけ設定する (もしくは変数を最初に設定する) 場合に、 += を使うのはやめてください。
簡単な makefile で、空行を使うのはやめてください。しかしより複雑で長いものに対しては、部分的に関連する項目をまとめるために使います。
基本的に WARNS は CFLAGS の修飾子ですが、 CFLAGS の前に置きます。 WARNS は重要なものであり、大量の CFLAGS の記述の中で見失わないように、 CFLAGS の後ろではなくて、 CFLAGS の前に置きます。コマンドラインや /etc/make.conf で上書きできるように、 WARNS は "WARNS?= " のように綴ります。
"NO_WERROR= yes" は使うべきでありません。これは WARNS の目的を無効にしてしまいます。これはコマンドラインで、かつ特殊な状況でのみ使用されるべきです。
CFLAGS は "CFLAGS+= " のように綴ります。
CFLAGS において、 -I の前に -D のリストを置くのは、アルファベット順という点からも、また -D を見やすくする点からも好ましいことです。 -D はしばしば条件つきのコンパイルに影響し、また -I は意外に長くなりがちです。長い CFLAGS の設定では -D と -I の間で分割します。
CFLAGS において、 GCC 的なもの ( -g や -Wall といったもの) を使うのはやめましょう。
一般的には VAR = と値の間に、 アスキー タブをひとつ入れます。値が 9 桁目から始まるようにするためです。変数名が 9 桁を超える場合は、単一の アスキー スペースで良いです。また変数名がとても長い場合は、ホワイトスペース無しでも良いです。
.include<bsd.*.mk> は最後です。
$< や、 $@ といった時代錯誤のものを使うのはやめましょう。代わりに ${.IMPSRC} か ${.ALLSRC} 、それと ${.TARGET} を使います。

論理的なグループ分けを表現したいために、上記のいくつかに従わないこともしばしばあります。

manページ — STYLE.MAKEFILE

名称

内容

解説

使用例

関連項目

歴史

バグ