Makefile
規則
<target> : <prerequisites>
[tab] <commands>
上面第一行冒號前面的部分,叫做"目標"(target),冒號後面的部分叫做"前置條件"(prerequisites);第二行必須由一個tab鍵起首,後面跟着"命令"(commands)。
"目標"是必需的,不可省略;"前置條件"和"命令"都是可選的,但是兩者之中必須至少存在一個。
每條規則就明確兩件事:構建目標的前置條件是什麼,以及如何構建。
目標
目標可以是文件或者操作名字
目標通常是文件名,指明Make命令所要構建的對象
除了文件名,目標還可以是某個操作的名字,這稱爲”僞目標”
clean:
rm *.o
但是,如果當前目錄中,正好有一個文件叫做clean,那麼這個命令不會執行。因爲Make發現clean文件已經存在,就認爲沒有必要重新構建了,就不會執行指定的rm命令。
爲了避免這種情況,可以明確聲明clean是”僞目標”,寫法如下。
.PHONY: clean
clean:
rm *.o temp
如果Make命令運行時沒有指定目標,默認會執行Makefile文件的第一個目標。
eg: make
前置條件
前置條件通常是一組文件名,之間用空格分隔。
它指定了”目標”是否重新構建的判斷標準:只要有一個前置文件不存在,或者有過更新(前置文件的last-modification時間戳比目標的時間戳新),”目標”就需要重新構建
result.txt: source.txt
cp source.txt result.txt
source.txt:
echo "this is the source" > source.txt
如果需要生成多個文件,往往採用下面的寫法。
source: file1 file2 file3
命令
命令(commands)表示如何更新目標文件,由一行或多行的Shell命令
組成
每行命令之前必須有一個tab鍵。如果想用其他鍵,可以用內置變量.RECIPEPREFIX聲明。
.RECIPEPREFIX = >
all:
> echo Hello, world
每行命令在一個單獨的shell中執行。這些Shell之間沒有繼承關係。
var-lost:
export foo=bar
echo "foo=[$$foo]"
上面代碼執行後(make var-lost),取不到foo的值。因爲兩行命令在兩個不同的進程執行。一個解決辦法是將兩行命令寫在一行,中間用分號分隔。
var-kept:
export foo=bar; echo "foo=[$$foo]"
另一個解決辦法是在換行符前加反斜槓轉義。
var-kept:
export foo=bar; \
echo "foo=[$$foo]"
最後一個方法是加上.ONESHELL:命令。
.ONESHELL:
var-kept:
export foo=bar;
echo "foo=[$$foo]"
語法
- 註釋
#
- echo
正常情況下,make會打印每條命令,然後再執行,這就叫做回聲(echoing)。
test:
# 這是測試
執行上面的規則,會得到下面的結果。
$ make test
# 這是測試
在命令的前面加上@,就可以關閉回聲。
test:
@# 這是測試
現在再執行make test,就不會有任何輸出。
由於在構建過程中,需要了解當前在執行哪條命令,所以通常只在註釋和純顯示的echo命令前面加上@。
test:
@# 這是測試
@echo TODO
- 通配符
通配符(wildcard)用來指定一組符合條件的文件名。Makefile 的通配符與 Bash 一致,主要有星號(*)、問號(?)和 [...]
- 模式匹配
Make命令允許對文件名,進行類似正則運算的匹配,主要用到的匹配符是%。比如,假定當前目錄下有 f1.c 和 f2.c 兩個源碼文件,需要將它們編譯爲對應的對象文件。
%.o: %.c
等同於下面的寫法。
f1.o: f1.c
f2.o: f2.c
使用匹配符%,可以將大量同類型的文件,只用一條規則就完成構建。
- 變量和賦值符
Makefile 允許使用等號自定義變量。
txt = Hello World
test:
@echo $(txt)
上面代碼中,變量 txt 等於 Hello World。調用時,變量需要放在 $( ) 之中。
調用Shell變量,需要在美元符號前,再加一個美元符號,這是因爲Make命令會對美元符號轉義。
test:
@echo $$HOME
有時,變量的值可能指向另一個變量。
v1 = $(v2)
上面代碼中,變量 v1 的值是另一個變量 v2。這時會產生一個問題,v1 的值到底在定義時擴展(靜態擴展),還是在運行時擴展(動態擴展)?如果 v2 的值是動態的,這兩種擴展方式的結果可能會差異很大。
爲了解決類似問題,Makefile一共提供了四個賦值運算符 (=、:=、?=、+=),它們的區別請看StackOverflow。
VARIABLE = value
# 在執行時擴展,允許遞歸擴展。
VARIABLE := value
# 在定義時擴展。
VARIABLE ?= value
# 只有在該變量爲空時才設置值。
VARIABLE += value
# 將值追加到變量的尾端。
內置變量(Implicit Variables)
Make命令提供一系列內置變量,比如,
output:
$(CC) -o output input.c
自動變量
(1)$@
$@指代當前目標,就是Make命令當前構建的那個目標。比如,make foo的 $@ 就指代foo。
a.txt b.txt:
touch $@
等同於下面的寫法。
a.txt:
touch a.txt
b.txt:
touch b.txt
(2)$<
$< 指代第一個前置條件。比如,規則爲 t: p1 p2,那麼$< 就指代p1。
a.txt: b.txt c.txt
cp $< $@
等同於下面的寫法。
a.txt: b.txt c.txt
cp b.txt a.txt
(3)$?
$? 指代比目標更新的所有前置條件,之間以空格分隔。比如,規則爲 t: p1 p2,其中 p2 的時間戳比 t 新,$?就指代p2。
(4)$^
$^ 指代所有前置條件,之間以空格分隔。比如,規則爲 t: p1 p2,那麼 $^ 就指代 p1 p2 。
(5)$*
$* 指代匹配符 % 匹配的部分, 比如% 匹配 f1.txt 中的f1 ,$* 就表示 f1。
(6)$(@D) 和 $(@F)
$(@D) 和 $(@F) 分別指向 $@ 的目錄名和文件名。比如,$@是 src/input.c,那麼$(@D) 的值爲 src ,$(@F) 的值爲 input.c。
(7)$(<D) 和 $(<F)
$(<D) 和 $(<F) 分別指向 $< 的目錄名和文件名。
所有的自動變量清單,請看手冊。下面是自動變量的一個例子。
dest/%.txt: src/%.txt
@[ -d dest ] || mkdir dest
cp $< $@
上面代碼將 src 目錄下的 txt 文件,拷貝到 dest 目錄下。首先判斷 dest 目錄是否存在,如果不存在就新建,然後,$< 指代前置文件(src/%.txt), $@ 指代目標文件(dest/%.txt)。
判斷和循環
Makefile使用 Bash 語法,完成判斷和循環。
ifeq ($(CC),gcc)
libs=$(libs_for_gcc)
else
libs=$(normal_libs)
endif
上面代碼判斷當前編譯器是否 gcc ,然後指定不同的庫文件。
LIST = one two three
all:
for i in $(LIST); do \
echo $$i; \
done
# 等同於
all:
for i in one two three; do \
echo $i; \
done
上面代碼的運行結果。
one
two
three
函數
Makefile 還可以使用函數,格式如下。
$(function arguments)
# 或者
${function arguments}
Makefile提供了許多內置函數,可供調用。下面是幾個常用的內置函數。
(1)shell 函數
shell 函數用來執行 shell 命令
srcfiles := $(shell echo src/{00..99}.txt)
(2)wildcard 函數
wildcard 函數用來在 Makefile 中,替換 Bash 的通配符。
srcfiles := $(wildcard src/*.txt)
(3)subst 函數
subst 函數用來文本替換,格式如下。
$(subst from,to,text)
下面的例子將字符串"feet on the street"替換成"fEEt on the strEEt"。
$(subst ee,EE,feet on the street)
下面是一個稍微複雜的例子。
comma:= ,
empty:=
# space變量用兩個空變量作爲標識符,當中是一個空格
space:= $(empty) $(empty)
foo:= a b c
bar:= $(subst $(space),$(comma),$(foo))
# bar is now `a,b,c'.
(4)patsubst函數
patsubst 函數用於模式匹配的替換,格式如下。
$(patsubst pattern,replacement,text)
下面的例子將文件名"x.c.c bar.c",替換成"x.c.o bar.o"。
$(patsubst %.c,%.o,x.c.c bar.c)
(5)替換後綴名
替換後綴名函數的寫法是:變量名 + 冒號 + 後綴名替換規則。它實際上patsubst函數的一種簡寫形式。
min: $(OUTPUT:.js=.min.js)
上面代碼的意思是,將變量OUTPUT中的後綴名 .js 全部替換成 .min.js 。
實例
(1)執行多個目標
.PHONY: cleanall cleanobj cleandiff
cleanall : cleanobj cleandiff
rm program
cleanobj :
rm *.o
cleandiff :
rm *.diff
上面代碼可以調用不同目標,刪除不同後綴名的文件,也可以調用一個目標(cleanall),刪除所有指定類型的文件。
(2)編譯C語言項目
edit : main.o kbd.o command.o display.o
cc -o edit main.o kbd.o command.o display.o
main.o : main.c defs.h
cc -c main.c
kbd.o : kbd.c defs.h command.h
cc -c kbd.c
command.o : command.c defs.h command.h
cc -c command.c
display.o : display.c defs.h
cc -c display.c
clean :
rm edit main.o kbd.o command.o display.o
.PHONY: edit clean