make
是工程構建的必要工具。
Make
這個詞,英語的意思是”制作”。Make
命令直接用了這個意思,就是要做出某個文件。比如,要做出文件a.txt
,就可以執行下面的命令。
$ make a.txt
但是,如果你真的輸入這條命令,它並不會起作用。因為Make
命令本身並不知道,如何做出a.txt
,需要有人告訴它,如何調用其他命令完成這個目標。
比如,假設文件a.txt
依賴於b.txt
和 c.txt
,是後面兩個文件連接(cat
命令)的產物。那麼,make
需要知道下面的規則。
a.txt: b.txt c.txt
cat b.txt c.txt > a.txt
也就是說,make a.txt
這條命令的背後,實際上分成兩步:第一步,確認 b.txt
和 c.txt
必須已經存在,第二步使用 cat
命令 將這個兩個文件合並,輸出為新文件。
像這樣的規則,都寫在一個叫做Makefile
的文件中,Make
命令依賴這個文件進行構建。Makefile
文件也可以寫為makefile
, 或者用命令行參數指定為其他文件名。
$ make -f rules.txt # 或者 $ make --file=rules.txt
上面代碼指定make
命令依據rules.txt
文件中的規則,進行構建。
總之,make
只是一個根據指定的Shell
命令進行構建的工具。它的規則很簡單,你規定要構建哪個文件、它依賴哪些源文件,當那些文件有變動時,如何重新構建它。
構建規則都寫在Makefile
文件裡面,要學會如何Make
命令,就必須學會如何編寫Makefile
文件。
Makefile
文件由一系列規則(rules
)構成。每條規則的形式如下。
<target> : <prerequisites>
[tab] <commands>
上面第一行冒號前面的部分,叫做”目標”(target
),冒號後面的部分叫做前置條件(prerequisites
);第二行必須由一個tab
鍵起首,後面跟著命令(commands
)。
“目標”是必需的,不可省略;”前置條件”和”命令”都是可選的,但是兩者之中必須至少存在一個。
每條規則就明確兩件事:構建目標的前置條件是什麼,以及如何構建。下面就詳細講解,每條規則的這三個組成部分。
一個目標(target
)就構成一條規則。目標通常是文件名,指明Make
命令所要構建的對象,比如上文的 a.txt
。目標可以是一個文件名,也可以是多個文件名,之間用空格分隔。
除了文件名,目標還可以是某個操作的名字,這稱為”偽目標”(phony target
)。
clean: rm *.o
上面代碼的目標是clean
,它不是文件名,而是一個操作的名字,屬於”偽目標 “,作用是刪除對象文件。
$ make clean
但是,如果當前目錄中,正好有一個文件叫做clean
,那麼這個命令不會執行。因為Make
發現clean
文件已經存在,就認為沒有必要重新構建了,就不會執行指定的rm
命令。
為了避免這種情況,可以明確聲明clean
是”偽目標”,寫法如下。
.PHONY: clean
clean: rm *.o temp
聲明clean
是”偽目標”之後,make
就不會去檢查是否存在一個叫做clean
的文件,而是每次運行都執行對應的命令。像.PHONY
這樣的內置目標名還有不少,可以查看手冊。
如果Make
命令運行時沒有指定目標,默認會執行Makefile
文件的第一個目標。
$ make
上面代碼執行Makefile
文件的第一個目標。
前置條件通常是一組文件名,之間用空格分隔。它指定了”目標”是否重新構建的判斷標准:只要有一個前置文件不存在,或者有過更新(前置文件的last-modification
時間戳比目標的時間戳新),”目標”就需要重新構建。
result.txt: source.txt
cp source.txt result.txt
上面代碼中,構建 result.txt
的前置條件是 source.txt
。如果當前目錄中,source.txt
已經存在,那麼make result.txt
可以正常運行,否則必須再寫一條規則,來生成 source.txt
。
source.txt: echo "this is the source" > source.txt
上面代碼中,source.txt
後面沒有前置條件,就意味著它跟其他文件都無關,只要這個文件還不存在,每次調用make source.txt
,它都會生成。
$ make result.txt
$ make result.txt
上面命令連續執行兩次make result.txt
。第一次執行會先新建 source.txt
,然後再新建 result.txt
。第二次執行,Make
發現 source.txt
沒有變動(時間戳晚於 result.txt
),就不會執行任何操作,result.txt
也不會重新生成。
如果需要生成多個文件,往往采用下面的寫法。
source: file1 file2 file3
上面代碼中,source
是一個偽目標,只有三個前置文件,沒有任何對應的命令。
$ make source
執行make source
命令後,就會一次性生成 file1,file2,file3
三個文件。這比下面的寫法要方便很多。
$ make file1
$ make file2
$ make file3
命令(commands
)表示如何更新目標文件,由一行或多行的Shell
命令組成。它是構建”目標”的具體指令,它的運行結果通常就是生成目標文件。
每行命令之前必須有一個tab
鍵。如果想用其他鍵,可以用內置變量.RECIPEPREFIX
聲明。
.RECIPEPREFIX = > all: > echo Hello, world
上面代碼用.RECIPEPREFIX
指定,大於號(>
)替代tab
鍵。所以,每一行命令的起首變成了大於號,而不是tab
鍵。
需要注意的是,每行命令在一個單獨的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]"
井號(#
)在Makefile
中表示注釋。
# 這是注釋 result.txt: source.txt
# 這是注釋 cp source.txt result.txt
# 這也是注釋
正常情況下,make
會打印每條命令,然後再執行,這就叫做回聲(echoing)。
test: # 這是測試
執行上面的規則,會得到下面的結果。
$ make test # 這是測試
在命令的前面加上@
,就可以關閉回聲。
test: @# 這是測試
現在再執行make test
,就不會有任何輸出。
由於在構建過程中,需要了解當前在執行哪條命令,所以通常只在注釋和純顯示的echo
命令前面加上@
。
test: @# 這是測試 @echo TODO
通配符(wildcard
)用來指定一組符合條件的文件名。Makefile
的通配符與 Bash
一致,主要有星號(*
)、問號(?
)和[...]
。比如, *.o
表示所有後綴名為o
的文件。
clean: rm -f *.o
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 # 將值追加到變量的尾端。
Make
命令提供一系列內置變量,比如,$(CC)
指向當前使用的編譯器,$(MAKE)
指向當前使用的Make
工具。這主要是為了跨平台的兼容性,詳細的內置變量清單見手冊。
output: $(CC) -o output input.c
Make
命令還提供一些自動變量,它們的值與當前規則有關。主要有以下幾個。
$@
$@
指代當前目標,就是Make
命令當前構建的那個目標。比如,make foo
的 $@
就指代foo
。
a.txt b.txt: touch $@
等同於下面的寫法。
a.txt: touch a.txt
b.txt: touch b.txt
$<
$<
指代第一個前置條件。比如,規則為 t: p1 p2
,那麼$<
就指代p1
。
a.txt: b.txt c.txt
cp $< $@
等同於下面的寫法。
a.txt: b.txt c.txt
cp b.txt a.txt
$?
$?
指代比目標更新的所有前置條件,之間以空格分隔。比如,規則為 t: p1 p2
,其中 p2
的時間戳比 t
新,$?
就指代p2
。
$^
$^
指代所有前置條件,之間以空格分隔。比如,規則為 t: p1 p2
,那麼$^
就指代p1 p2
。
$*
$*
指代匹配符%
匹配的部分, 比如%
匹配 f1.txt
中的f1
,$*
就表示 f1
。
$(@D) 和 $(@F)
$(@D)
和$(@F)
分別指向$@
的目錄名和文件名。比如,$@
是 src/input.c
,那麼$(@D)
的值為 src
,$(@F)
的值為input.c
。
$(<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
提供了許多內置函數,可供調用。下面是幾個常用的內置函數。
shell
函數shell
函數用來執行 shell
命令
srcfiles := $(shell echo src/{00..99}.txt)
wildcard
函數wildcard
函數用來在 Makefile
中,替換 Bash
的通配符。
srcfiles := $(wildcard src/*.txt)
替換函數的寫法是:變量名 + 冒號 + 替換規則。
min: $(OUTPUT:.js=.min.js)
上面代碼的意思是,將變量OUTPUT
中的.js
全部替換成 .min.js
。
.PHONY: cleanall cleanobj cleandiff
cleanall : cleanobj cleandiff
rm program
cleanobj : rm *.o
cleandiff : rm *.diff
上面代碼可以調用不同目標,刪除不同後綴名的文件,也可以調用一個目標(cleanall
),刪除所有指定類型的文件。
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
實驗平台上Makefile詳細的解釋 http://www.linuxidc.com/Linux/2014-01/94827.htm
Makefile之Linux內核模塊的Makefile寫法分析 http://www.linuxidc.com/Linux/2013-06/85842.htm
Makefile之寫demo時的通用Makefile寫法 http://www.linuxidc.com/Linux/2013-05/84679.htm
Makefile之大型工程項目子目錄Makefile的一種通用寫法 http://www.linuxidc.com/Linux/2013-05/84678.htm