代碼變成可執(zhí)行文件,叫做編譯(compile);先編譯這個,還是先編譯那個(即編譯的安排),叫做構(gòu)建(build)。
Make是最常用的構(gòu)建工具,誕生于1977年,主要用于C語言的項目。但是實際上 ,任何只要某個文件有變化,就要重新構(gòu)建的項目,都可以用Make構(gòu)建。
本文介紹Make命令的用法,從簡單的講起,不需要任何基礎(chǔ),只要會使用命令行,就能看懂。我的參考資料主要是Isaac Schlueter的《Makefile文件教程》和《GNU Make手冊》。
(題圖:攝于博茲賈阿達島,土耳其,2013年7月)
Make這個詞,英語的意思是"制作"。Make命令直接用了這個意思,就是要做出某個文件。比如,要做出文件a.txt,就可以執(zhí)行下面的命令。
$ make a.txt
但是,如果你真的輸入這條命令,它并不會起作用。因為Make命令本身并不知道,如何做出a.txt,需要有人告訴它,如何調(diào)用其他命令完成這個目標。
比如,假設(shè)文件 a.txt 依賴于 b.txt 和 c.txt ,是后面兩個文件連接(cat命令)的產(chǎn)物。那么,make 需要知道下面的規(guī)則。
a.txt: b.txt c.txt cat b.txt c.txt > a.txt
也就是說,make a.txt 這條命令的背后,實際上分成兩步:第一步,確認 b.txt 和 c.txt 必須已經(jīng)存在,第二步使用 cat 命令 將這個兩個文件合并,輸出為新文件。
像這樣的規(guī)則,都寫在一個叫做Makefile的文件中,Make命令依賴這個文件進行構(gòu)建。Makefile文件也可以寫為makefile, 或者用命令行參數(shù)指定為其他文件名。
$ make -f rules.txt# 或者$ make --file=rules.txt
上面代碼指定make命令依據(jù)rules.txt文件中的規(guī)則,進行構(gòu)建。
總之,make只是一個根據(jù)指定的Shell命令進行構(gòu)建的工具。它的規(guī)則很簡單,你規(guī)定要構(gòu)建哪個文件、它依賴哪些源文件,當那些文件有變動時,如何重新構(gòu)建它。
構(gòu)建規(guī)則都寫在Makefile文件里面,要學(xué)會如何Make命令,就必須學(xué)會如何編寫Makefile文件。
Makefile文件由一系列規(guī)則(rules)構(gòu)成。每條規(guī)則的形式如下。
<target> : <prerequisites> [tab] <commands>
上面第一行冒號前面的部分,叫做"目標"(target),冒號后面的部分叫做"前置條件"(prerequisites);第二行必須由一個tab鍵起首,后面跟著"命令"(commands)。
"目標"是必需的,不可省略;"前置條件"和"命令"都是可選的,但是兩者之中必須至少存在一個。
每條規(guī)則就明確兩件事:構(gòu)建目標的前置條件是什么,以及如何構(gòu)建。下面就詳細講解,每條規(guī)則的這三個組成部分。
一個目標(target)就構(gòu)成一條規(guī)則。目標通常是文件名,指明Make命令所要構(gòu)建的對象,比如上文的 a.txt 。目標可以是一個文件名,也可以是多個文件名,之間用空格分隔。
除了文件名,目標還可以是某個操作的名字,這稱為"偽目標"(phony target)。
clean: rm *.o
上面代碼的目標是clean,它不是文件名,而是一個操作的名字,屬于"偽目標 ",作用是刪除對象文件。
$ make clean
但是,如果當前目錄中,正好有一個文件叫做clean,那么這個命令不會執(zhí)行。因為Make發(fā)現(xiàn)clean文件已經(jīng)存在,就認為沒有必要重新構(gòu)建了,就不會執(zhí)行指定的rm命令。
為了避免這種情況,可以明確聲明clean是"偽目標",寫法如下。
.PHONY: cleanclean: rm *.o temp
聲明clean是"偽目標"之后,make就不會去檢查是否存在一個叫做clean的文件,而是每次運行都執(zhí)行對應(yīng)的命令。像.PHONY這樣的內(nèi)置目標名還有不少,可以查看手冊。
如果Make命令運行時沒有指定目標,默認會執(zhí)行Makefile文件的第一個目標。
$ make
上面代碼執(zhí)行Makefile文件的第一個目標。
前置條件通常是一組文件名,之間用空格分隔。它指定了"目標"是否重新構(gòu)建的判斷標準:只要有一個前置文件不存在,或者有過更新(前置文件的last-modification時間戳比目標的時間戳新),"目標"就需要重新構(gòu)建。
result.txt: source.txt cp source.txt result.txt
上面代碼中,構(gòu)建 result.txt 的前置條件是 source.txt 。如果當前目錄中,source.txt 已經(jīng)存在,那么make result.txt
可以正常運行,否則必須再寫一條規(guī)則,來生成 source.txt 。
source.txt: echo "this is the source" > source.txt
上面代碼中,source.txt后面沒有前置條件,就意味著它跟其他文件都無關(guān),只要這個文件還不存在,每次調(diào)用make source.txt
,它都會生成。
$ make result.txt$ make result.txt
上面命令連續(xù)執(zhí)行兩次make result.txt
。第一次執(zhí)行會先新建 source.txt,然后再新建 result.txt。第二次執(zhí)行,Make發(fā)現(xiàn) source.txt 沒有變動(時間戳晚于 result.txt),就不會執(zhí)行任何操作,result.txt 也不會重新生成。
如果需要生成多個文件,往往采用下面的寫法。
source: file1 file2 file3
上面代碼中,source 是一個偽目標,只有三個前置文件,沒有任何對應(yīng)的命令。
$ make source
執(zhí)行make source
命令后,就會一次性生成 file1,file2,file3 三個文件。這比下面的寫法要方便很多。
$ make file1$ make file2$ make file3
命令(commands)表示如何更新目標文件,由一行或多行的Shell命令組成。它是構(gòu)建"目標"的具體指令,它的運行結(jié)果通常就是生成目標文件。
每行命令之前必須有一個tab鍵。如果想用其他鍵,可以用內(nèi)置變量.RECIPEPREFIX聲明。
.RECIPEPREFIX = >all:> echo Hello, world
上面代碼用.RECIPEPREFIX指定,大于號(>)替代tab鍵。所以,每一行命令的起首變成了大于號,而不是tab鍵。
需要注意的是,每行命令在一個單獨的shell中執(zhí)行。這些Shell之間沒有繼承關(guān)系。
var-lost: export foo=bar echo "foo=[$$foo]"
上面代碼執(zhí)行后(make var-lost
),取不到foo的值。因為兩行命令在兩個不同的進程執(zhí)行。一個解決辦法是將兩行命令寫在一行,中間用分號分隔。
var-kept: export foo=bar; echo "foo=[$$foo]"
另一個解決辦法是在換行符前加反斜杠轉(zhuǎn)義。
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會打印每條命令,然后再執(zhí)行,這就叫做回聲(echoing)。
test: # 這是測試
執(zhí)行上面的規(guī)則,會得到下面的結(jié)果。
$ make test# 這是測試
在命令的前面加上@,就可以關(guān)閉回聲。
test: @# 這是測試
現(xiàn)在再執(zhí)行make test
,就不會有任何輸出。
由于在構(gòu)建過程中,需要了解當前在執(zhí)行哪條命令,所以通常只在注釋和純顯示的echo命令前面加上@。
test: @# 這是測試 @echo TODO
通配符(wildcard)用來指定一組符合條件的文件名。Makefile 的通配符與 Bash 一致,主要有星號(*)、問號(?)和 [...] 。比如, *.o 表示所有后綴名為o的文件。
clean: rm -f *.o
Make命令允許對文件名,進行類似正則運算的匹配,主要用到的匹配符是%。比如,假定當前目錄下有 f1.c 和 f2.c 兩個源碼文件,需要將它們編譯為對應(yīng)的對象文件。
%.o: %.c
等同于下面的寫法。
f1.o: f1.cf2.o: f2.c
使用匹配符%,可以將大量同類型的文件,只用一條規(guī)則就完成構(gòu)建。
Makefile 允許使用等號自定義變量。
txt = Hello Worldtest: @echo $(txt)
上面代碼中,變量 txt 等于 Hello World。調(diào)用時,變量需要放在 $( ) 之中。
調(diào)用Shell變量,需要在美元符號前,再加一個美元符號,這是因為Make命令會對美元符號轉(zhuǎn)義。
test: @echo $$HOME
有時,變量的值可能指向另一個變量。
v1 = $(v2)
上面代碼中,變量 v1 的值是另一個變量 v2。這時會產(chǎn)生一個問題,v1 的值到底在定義時擴展(靜態(tài)擴展),還是在運行時擴展(動態(tài)擴展)?如果 v2 的值是動態(tài)的,這兩種擴展方式的結(jié)果可能會差異很大。
為了解決類似問題,Makefile一共提供了四個賦值運算符 (=、:=、?=、+=),它們的區(qū)別請看StackOverflow。
VARIABLE = value# 在執(zhí)行時擴展,允許遞歸擴展。VARIABLE := value# 在定義時擴展。VARIABLE ?= value# 只有在該變量為空時才設(shè)置值。VARIABLE += value# 將值追加到變量的尾端。
Make命令提供一系列內(nèi)置變量,比如,$(CC) 指向當前使用的編譯器,$(MAKE) 指向當前使用的Make工具。這主要是為了跨平臺的兼容性,詳細的內(nèi)置變量清單見手冊。
output: $(CC) -o output input.c
Make命令還提供一些自動變量,它們的值與當前規(guī)則有關(guān)。主要有以下幾個。
(1)$@
$@指代當前目標,就是Make命令當前構(gòu)建的那個目標。比如,make foo
的 $@ 就指代foo。
a.txt b.txt: touch $@
等同于下面的寫法。
a.txt: touch a.txtb.txt: touch b.txt
(2)$<
$< 指代第一個前置條件。比如,規(guī)則為 t: p1 p2,那么$< 就指代p1。
a.txt: b.txt c.txt cp $< $@
等同于下面的寫法。
a.txt: b.txt c.txt cp b.txt a.txt
(3)$?
$? 指代比目標更新的所有前置條件,之間以空格分隔。比如,規(guī)則為 t: p1 p2,其中 p2 的時間戳比 t 新,$?就指代p2。
(4)$^
$^ 指代所有前置條件,之間以空格分隔。比如,規(guī)則為 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 語法,完成判斷和循環(huán)。
ifeq ($(CC),gcc) libs=$(libs_for_gcc)else libs=$(normal_libs)endif
上面代碼判斷當前編譯器是否 gcc ,然后指定不同的庫文件。
LIST = one two threeall: for i in $(LIST); do echo $$i; done# 等同于all: for i in one two three; do echo $i; done
上面代碼的運行結(jié)果。
onetwothree
Makefile 還可以使用函數(shù),格式如下。
$(function arguments)# 或者${function arguments}
Makefile提供了許多內(nèi)置函數(shù),可供調(diào)用。下面是幾個常用的內(nèi)置函數(shù)。
(1)shell 函數(shù)
shell 函數(shù)用來執(zhí)行 shell 命令
srcfiles := $(shell echo src/{00..99}.txt)
(2)wildcard 函數(shù)
wildcard 函數(shù)用來在 Makefile 中,替換 Bash 的通配符。
srcfiles := $(wildcard src/*.txt)
(3)subst 函數(shù)
subst 函數(shù)用來文本替換,格式如下。
$(subst from,to,text)
下面的例子將字符串"feet on the street"替換成"fEEt on the strEEt"。
$(subst ee,EE,feet on the street)
下面是一個稍微復(fù)雜的例子。
comma:= ,empty:=# space變量用兩個空變量作為標識符,當中是一個空格space:= $(empty) $(empty)foo:= a b cbar:= $(subst $(space),$(comma),$(foo))# bar is now `a,b,c'.
(4)patsubst函數(shù)
patsubst 函數(shù)用于模式匹配的替換,格式如下。
$(patsubst pattern,replacement,text)
下面的例子將文件名"x.c.c bar.c",替換成"x.c.o bar.o"。
$(patsubst %.c,%.o,x.c.c bar.c)
(5)替換后綴名
替換后綴名函數(shù)的寫法是:變量名 + 冒號 + 后綴名替換規(guī)則。它實際上patsubst函數(shù)的一種簡寫形式。
min: $(OUTPUT:.js=.min.js)
上面代碼的意思是,將變量OUTPUT中的后綴名 .js 全部替換成 .min.js 。
(1)執(zhí)行多個目標
.PHONY: cleanall cleanobj cleandiffcleanall : cleanobj cleandiff rm programcleanobj : rm *.ocleandiff : rm *.diff
上面代碼可以調(diào)用不同目標,刪除不同后綴名的文件,也可以調(diào)用一個目標(cleanall),刪除所有指定類型的文件。
(2)編譯C語言項目
edit : main.o kbd.o command.o display.o cc -o edit main.o kbd.o command.o display.omain.o : main.c defs.h cc -c main.ckbd.o : kbd.c defs.h command.h cc -c kbd.ccommand.o : command.c defs.h command.h cc -c command.cdisplay.o : display.c defs.h cc -c display.cclean : rm edit main.o kbd.o command.o display.o.PHONY: edit clean
今天,Make命令的介紹就到這里。下一篇文章我會介紹,如何用 Make 來構(gòu)建 Node.js 項目。
(完)