書寫規(guī)則 - linux makefile教程

　　書寫規(guī)則

　　————

　　規(guī)則包含兩個部分，一個是依賴關(guān)系，一個是生成目標(biāo)的方法。

　　在Makefile中，規(guī)則的順序是很重要的，因為，Makefile中只應(yīng)該有一個最終目標(biāo)，其它的目標(biāo)都是被這個目標(biāo)所連帶出來的，所以一定要讓make知道你的最終目標(biāo)是什么。一般來說，定義在Makefile中的目標(biāo)可能會有很多，但是第一條規(guī)則中的目標(biāo)將被確立為最終的目標(biāo)。如果第一條規(guī)則中的目標(biāo)有很多個，那么，第一個目標(biāo)會成為最終的目標(biāo)。make所完成的也就是這個目標(biāo)。

　　好了，還是讓我們來看一看如何書寫規(guī)則。

　　一、規(guī)則舉例

　　foo.o ： foo.c defs.h # foo模塊

　　cc -c -g foo.c

　　看到這個例子，各位應(yīng)該不是很陌生了，前面也已說過，foo.o是我們的目標(biāo)，foo.c和defs.h是目標(biāo)所依賴的源文件，而只有一個命令“cc -c -g foo.c”（以Tab鍵開頭）。這個規(guī)則告訴我們兩件事：

　　1、文件的依賴關(guān)系，foo.o依賴于foo.c和defs.h的文件，如果foo.c和defs.h的文件日期要比foo.o文件日期要新，或是foo.o不存在，那么依賴關(guān)系發(fā)生。

　　2、如果生成（或更新）foo.o文件。也就是那個cc命令，其說明了，如何生成foo.o這個文件。（當(dāng)然foo.c文件include了defs.h文件）

　　二、規(guī)則的語法

　　targets ： prerequisites

　　command

　　。。.

　　或是這樣：

　　targets ： prerequisites ; command

　　command

　　。。.

　　targets是文件名，以空格分開，可以使用通配符。一般來說，我們的目標(biāo)基本上是一個文件，但也有可能是多個文件。

　　command是命令行，如果其不與“targetrerequisites”在一行，那么，必須以［Tab鍵］開頭，如果和prerequisites在一行，那么可以用分號做為分隔。（見上）

　　prerequisites也就是目標(biāo)所依賴的文件（或依賴目標(biāo)）。如果其中的某個文件要比目標(biāo)文件要新，那么，目標(biāo)就被認(rèn)為是“過時的”，被認(rèn)為是需要重生成的。這個在前面已經(jīng)講過了。

　　如果命令太長，你可以使用反斜框（‘/’）作為換行符。make對一行上有多少個字符沒有限制。規(guī)則告訴make兩件事，文件的依賴關(guān)系和如何成成目標(biāo)文件。

　　一般來說，make會以UNIX的標(biāo)準(zhǔn)Shell，也就是/bin/sh來執(zhí)行命令。

　　三、在規(guī)則中使用通配符

　　如果我們想定義一系列比較類似的文件，我們很自然地就想起使用通配符。make支持三各通配符：“*”，“？”和“［。。.］”。這是和Unix的B-Shell是相同的。

　　波浪號（“~”）字符在文件名中也有比較特殊的用途。如果是“~/test”，這就表示當(dāng)前用戶的$HOME目錄下的test目錄。而“~hchen/test”則表示用戶hchen的宿主目錄下的test目錄。（這些都是Unix下的小知識了，make也支持）而在Windows或是MS-DOS下，用戶沒有宿主目錄，那么波浪號所指的目錄則根據(jù)環(huán)境變量“HOME”而定。

　　通配符代替了你一系列的文件，如“*.c”表示所以后綴為c的文件。一個需要我們注意的是，如果我們的文件名中有通配符，如：“*”，那么可以用轉(zhuǎn)義字符“/”，如“/*”來表示真實的“*”字符，而不是任意長度的字符串。

　　好吧，還是先來看幾個例子吧：

　　clean：

　　rm -f *.o

　　上面這個例子我不不多說了，這是操作系統(tǒng)Shell所支持的通配符。這是在命令中的通配符。

　　print： *.c

　　lpr -p $？

　　touch print

　　上面這個例子說明了通配符也可以在我們的規(guī)則中，目標(biāo)print依賴于所有的［.c］文件。其中的“$？”是一個自動化變量，我會在后面給你講述。

　　objects = *.o

　　上面這個例子，表示了，通符同樣可以用在變量中。并不是說［*.o］會展開，不！objects的值就是“*.o”。Makefile中的變量其實就是C/C++中的宏。如果你要讓通配符在變量中展開，也就是讓objects的值是所有［.o］的文件名的集合，那么，你可以這樣：

　　objects ：= $（wildcard *.o）

　　這種用法由關(guān)鍵字“wildcard”指出，關(guān)于Makefile的關(guān)鍵字，我們將在后面討論。

　　四、文件搜尋

　　在一些大的工程中，有大量的源文件，我們通常的做法是把這許多的源文件分類，并存放在不同的目錄中。所以，當(dāng)make需要去找尋文件的依賴關(guān)系時，你可以在文件前加上路徑，但最好的方法是把一個路徑告訴make，讓make在自動去找。

　　Makefile文件中的特殊變量“VPATH”就是完成這個功能的，如果沒有指明這個變量，make只會在當(dāng)前的目錄中去找尋依賴文件和目標(biāo)文件。如果定義了這個變量，那么，make就會在當(dāng)當(dāng)前目錄找不到的情況下，到所指定的目錄中去找尋文件了。

　　VPATH = src：。。/headers

　　上面的的定義指定兩個目錄，“src”和“。。/headers”，make會按照這個順序進(jìn)行搜索。目錄由“冒號”分隔。（當(dāng)然，當(dāng)前目錄永遠(yuǎn)是最高優(yōu)先搜索的地方）

　　另一個設(shè)置文件搜索路徑的方法是使用make的“vpath”關(guān)鍵字（注意，它是全小寫的），這不是變量，這是一個make的關(guān)鍵字，這和上面提到的那個VPATH變量很類似，但是它更為靈活。它可以指定不同的文件在不同的搜索目錄中。這是一個很靈活的功能。它的使用方法有三種：

　　1、vpath 《pattern》 《directories》

　　為符合模式《pattern》的文件指定搜索目錄《directories》。

　　2、vpath 《pattern》

　　清除符合模式《pattern》的文件的搜索目錄。

　　3、vpath

　　清除所有已被設(shè)置好了的文件搜索目錄。

　　vapth使用方法中的《pattern》需要包含“%”字符?！?”的意思是匹配零或若干字符，例如，“%.h”表示所有以“.h”結(jié)尾的文件?！秔attern》指定了要搜索的文件集，而《directories》則指定了《pattern》的文件集的搜索的目錄。例如：

　　vpath %.h 。。/headers

　　該語句表示，要求make在“。。/headers”目錄下搜索所有以“.h”結(jié)尾的文件。（如果某文件在當(dāng)前目錄沒有找到的話）

　　我們可以連續(xù)地使用vpath語句，以指定不同搜索策略。如果連續(xù)的vpath語句中出現(xiàn)了相同的《pattern》，或是被重復(fù)了的《pattern》，那么，make會按照vpath語句的先后順序來執(zhí)行搜索。如：

　　vpath %.c foo

　　vpath % blish

　　vpath %.c bar

　　其表示“.c”結(jié)尾的文件，先在“foo”目錄，然后是“blish”，最后是“bar”目錄。

　　vpath %.c foo:bar

　　vpath % blish

　　而上面的語句則表示“.c”結(jié)尾的文件，先在“foo”目錄，然后是“bar”目錄，最后才是“blish”目錄。

　　五、偽目標(biāo)

　　最早先的一個例子中，我們提到過一個“clean”的目標(biāo)，這是一個“偽目標(biāo)”，

　　clean：

　　rm *.o temp

　　正像我們前面例子中的“clean”一樣，即然我們生成了許多文件編譯文件，我們也應(yīng)該提供一個清除它們的“目標(biāo)”以備完整地重編譯而用。 （以“make clean”來使用該目標(biāo)）

　　因為，我們并不生成“clean”這個文件。“偽目標(biāo)”并不是一個文件，只是一個標(biāo)簽，由于“偽目標(biāo)”不是文件，所以make無法生成它的依賴關(guān)系和決定它是否要執(zhí)行。我們只有通過顯示地指明這個“目標(biāo)”才能讓其生效。當(dāng)然，“偽目標(biāo)”的取名不能和文件名重名，不然其就失去了“偽目標(biāo)”的意義了。

　　當(dāng)然，為了避免和文件重名的這種情況，我們可以使用一個特殊的標(biāo)記“.PHONY”來顯示地指明一個目標(biāo)是“偽目標(biāo)”，向make說明，不管是否有這個文件，這個目標(biāo)就是“偽目標(biāo)”。

　　.PHONY ： clean

　　只要有這個聲明，不管是否有“clean”文件，要運行“clean”這個目標(biāo)，只有“make clean”這樣。于是整個過程可以這樣寫：

　　.PHONY： clean

　　clean：

　　rm *.o temp

　　偽目標(biāo)一般沒有依賴的文件。但是，我們也可以為偽目標(biāo)指定所依賴的文件。偽目標(biāo)同樣可以作為“默認(rèn)目標(biāo)”，只要將其放在第一個。一個示例就是，如果你的Makefile需要一口氣生成若干個可執(zhí)行文件，但你只想簡單地敲一個make完事，并且，所有的目標(biāo)文件都寫在一個Makefile中，那么你可以使用“偽目標(biāo)”這個特性：

　　all ： prog1 prog2 prog3

　　.PHONY ： all

　　prog1 ： prog1.o utils.o

　　cc -o prog1 prog1.o utils.o

　　prog2 ： prog2.o

　　cc -o prog2 prog2.o

　　prog3 ： prog3.o sort.o utils.o

　　cc -o prog3 prog3.o sort.o utils.o

　　我們知道，Makefile中的第一個目標(biāo)會被作為其默認(rèn)目標(biāo)。我們聲明了一個“all”的偽目標(biāo)，其依賴于其它三個目標(biāo)。由于偽目標(biāo)的特性是，總是被執(zhí)行的，所以其依賴的那三個目標(biāo)就總是不如“all”這個目標(biāo)新。所以，其它三個目標(biāo)的規(guī)則總是會被決議。也就達(dá)到了我們一口氣生成多個目標(biāo)的目的。“.PHONY ： all”聲明了“all”這個目標(biāo)為“偽目標(biāo)”。

　　隨便提一句，從上面的例子我們可以看出，目標(biāo)也可以成為依賴。所以，偽目標(biāo)同樣也可成為依賴?？聪旅娴睦樱?/p>

　　.PHONY： cleanall cleanobj cleandiff

　　cleanall ： cleanobj cleandiff

　　rm program

　　cleanobj ：

　　rm *.o

　　cleandiff ：

　　rm *.diff

　　“make clean”將清除所有要被清除的文件?！癱leanobj”和“cleandiff”這兩個偽目標(biāo)有點像“子程序”的意思。我們可以輸入“make cleanall”和“make cleanobj”和“make cleandiff”命令來達(dá)到清除不同種類文件的目的。

　　六、多目標(biāo)

　　Makefile的規(guī)則中的目標(biāo)可以不止一個，其支持多目標(biāo)，有可能我們的多個目標(biāo)同時依賴于一個文件，并且其生成的命令大體類似。于是我們就能把其合并起來。當(dāng)然，多個目標(biāo)的生成規(guī)則的執(zhí)行命令是同一個，這可能會可我們帶來麻煩，不過好在我們的可以使用一個自動化變量“$@”（關(guān)于自動化變量，將在后面講述），這個變量表示著目前規(guī)則中所有的目標(biāo)的集合，這樣說可能很抽象，還是看一個例子吧。

　　bigoutput littleoutput ： text.g

　　generate text.g -$（subst output，，$@） 》 $@

　　上述規(guī)則等價于：

　　bigoutput ： text.g

　　generate text.g -big 》 bigoutput

　　littleoutput ： text.g

　　generate text.g -little 》 littleoutput

　　其中，-$（subst output，，$@）中的“$”表示執(zhí)行一個Makefile的函數(shù)，函數(shù)名為subst，后面的為參數(shù)。關(guān)于函數(shù)，將在后面講述。這里的這個函數(shù)是截取字符串的意思，“$@”表示目標(biāo)的集合，就像一個數(shù)組，“$@”依次取出目標(biāo)，并執(zhí)于命令。

　　七、靜態(tài)模式

　　靜態(tài)模式可以更加容易地定義多目標(biāo)的規(guī)則，可以讓我們的規(guī)則變得更加的有彈性和靈活。我們還是先來看一下語法：

　　《targets 。。.》： 《target-pattern》： 《prereq-patterns 。。.》

　　《commands》

　　。。.

　　targets定義了一系列的目標(biāo)文件，可以有通配符。是目標(biāo)的一個集合。

　　target-parrtern是指明了targets的模式，也就是的目標(biāo)集模式。

　　prereq-parrterns是目標(biāo)的依賴模式，它對target-parrtern形成的模式再進(jìn)行一次依賴目標(biāo)的定義。

　　這樣描述這三個東西，可能還是沒有說清楚，還是舉個例子來說明一下吧。如果我們的《target-parrtern》定義成“%.o”，意思是我們的《target》集合中都是以“.o”結(jié)尾的，而如果我們的《prereq-parrterns》定義成“%.c”，意思是對《target-parrtern》所形成的目標(biāo)集進(jìn)行二次定義，其計算方法是，取《target-parrtern》模式中的“%”（也就是去掉了［.o］這個結(jié)尾），并為其加上［.c］這個結(jié)尾，形成的新集合。

　　所以，我們的“目標(biāo)模式”或是“依賴模式”中都應(yīng)該有“%”這個字符，如果你的文件名中有“%”那么你可以使用反斜杠“/”進(jìn)行轉(zhuǎn)義，來標(biāo)明真實的“%”字符。

　　看一個例子：

　　objects = foo.o bar.o

　　all： $（objects）

　　$（objects）： %.o： %.c

　　$（CC） -c $（CFLAGS） $《 -o $@

　　上面的例子中，指明了我們的目標(biāo)從$object中獲取，“%.o”表明要所有以“.o”結(jié)尾的目標(biāo)，也就是“foo.o bar.o”，也就是變量$object集合的模式，而依賴模式“%.c”則取模式“%.o”的“%”，也就是“foo bar”，并為其加下“.c”的后綴，于是，我們的依賴目標(biāo)就是“foo.c bar.c”。而命令中的“$《”和“$@”則是自動化變量，“$《”表示所有的依賴目標(biāo)集（也就是“foo.c bar.c”），“$@”表示目標(biāo)集（也就是“foo.o bar.o”）。于是，上面的規(guī)則展開后等價于下面的規(guī)則：

　　foo.o ： foo.c

　　$（CC） -c $（CFLAGS） foo.c -o foo.o

　　bar.o ： bar.c

　　$（CC） -c $（CFLAGS） bar.c -o bar.o

　　試想，如果我們的“%.o”有幾百個，那種我們只要用這種很簡單的“靜態(tài)模式規(guī)則”就可以寫完一堆規(guī)則，實在是太有效率了?！办o態(tài)模式規(guī)則”的用法很靈活，如果用得好，那會一個很強(qiáng)大的功能。再看一個例子：

　　files = foo.elc bar.o lose.o

　　$（filter %.o，$（files））： %.o： %.c

　　$（CC） -c $（CFLAGS） $《 -o $@

　　$（filter %.elc，$（files））： %.elc： %.el

　　emacs -f batch-byte-compile $《

　　$（filter %.o，$（files））表示調(diào)用Makefile的filter函數(shù)，過濾“$filter”集，只要其中模式為“%.o”的內(nèi)容。其的它內(nèi)容，我就不用多說了吧。這個例字展示了Makefile中更大的彈性。

　　八、自動生成依賴性

　　在Makefile中，我們的依賴關(guān)系可能會需要包含一系列的頭文件，比如，如果我們的main.c中有一句“#include “defs.h””，那么我們的依賴關(guān)系應(yīng)該是：

　　main.o ： main.c defs.h

　　但是，如果是一個比較大型的工程，你必需清楚哪些C文件包含了哪些頭文件，并且，你在加入或刪除頭文件時，也需要小心地修改Makefile，這是一個很沒有維護(hù)性的工作。為了避免這種繁重而又容易出錯的事情，我們可以使用C/C++編譯的一個功能。大多數(shù)的C/C++編譯器都支持一個“-M”的選項，即自動找尋源文件中包含的頭文件，并生成一個依賴關(guān)系。例如，如果我們執(zhí)行下面的命令：

　　cc -M main.c

　　其輸出是：

　　main.o ： main.c defs.h

　　于是由編譯器自動生成的依賴關(guān)系，這樣一來，你就不必再手動書寫若干文件的依賴關(guān)系，而由編譯器自動生成了。需要提醒一句的是，如果你使用GNU的C/C++編譯器，你得用“-MM”參數(shù)，不然，“-M”參數(shù)會把一些標(biāo)準(zhǔn)庫的頭文件也包含進(jìn)來。

　　gcc -M main.c的輸出是：

　　main.o： main.c defs.h /usr/include/stdio.h /usr/include/features.h /

　　/usr/include/sys/cdefs.h /usr/include/gnu/stubs.h /

　　/usr/lib/gcc-lib/i486-suse-linux/2.95.3/include/stddef.h /

　　/usr/include/bits/types.h /usr/include/bits/pthreadtypes.h /

　　/usr/include/bits/sched.h /usr/include/libio.h /

　　/usr/include/_G_config.h /usr/include/wchar.h /

　　/usr/include/bits/wchar.h /usr/include/gconv.h /

　　/usr/lib/gcc-lib/i486-suse-linux/2.95.3/include/stdarg.h /

　　/usr/include/bits/stdio_lim.h

　　gcc -MM main.c的輸出則是：

　　main.o： main.c defs.h

　　那么，編譯器的這個功能如何與我們的Makefile聯(lián)系在一起呢。因為這樣一來，我們的Makefile也要根據(jù)這些源文件重新生成，讓Makefile自已依賴于源文件？這個功能并不現(xiàn)實，不過我們可以有其它手段來迂回地實現(xiàn)這一功能。GNU組織建議把編譯器為每一個源文件的自動生成的依賴關(guān)系放到一個文件中，為每一個“name.c”的文件都生成一個“name.d”的Makefile文件，［.d］文件中就存放對應(yīng)［.c］文件的依賴關(guān)系。

　　于是，我們可以寫出［.c］文件和［.d］文件的依賴關(guān)系，并讓make自動更新或自成［.d］文件，并把其包含在我們的主Makefile中，這樣，我們就可以自動化地生成每個文件的依賴關(guān)系了。

　　這里，我們給出了一個模式規(guī)則來產(chǎn)生［.d］文件：

　　%.d： %.c

　　@set -e; rm -f $@; /

　　$（CC） -M $（CPPFLAGS） $《 》 $@.

　　; /

　　sed ‘s，/（$*/）/.o［ ：］*，/1.o $@ ： ，g’ 《 $@.

　　》 $@; /

　　rm -f $@.

　　這個規(guī)則的意思是，所有的［.d］文件依賴于［.c］文件，“rm -f $@”的意思是刪除所有的目標(biāo)，也就是［.d］文件，第二行的意思是，為每個依賴文件“$《”，也就是［.c］文件生成依賴文件，“$@”表示模式“%.d”文件，如果有一個C文件是name.c，那么“%”就是“name”，“

　　”意為一個隨機(jī)編號，第二行生成的文件有可能是“name.d.12345”，第三行使用sed命令做了一個替換，關(guān)于sed命令的用法請參看相關(guān)的使用文檔。第四行就是刪除臨時文件。

　　總而言之，這個模式要做的事就是在編譯器生成的依賴關(guān)系中加入［.d］文件的依賴，即把依賴關(guān)系：

　　main.o ： main.c defs.h

　　轉(zhuǎn)成：

　　main.o main.d ： main.c defs.h

　　于是，我們的［.d］文件也會自動更新了，并會自動生成了，當(dāng)然，你還可以在這個［.d］文件中加入的不只是依賴關(guān)系，包括生成的命令也可一并加入，讓每個［.d］文件都包含一個完賴的規(guī)則。一旦我們完成這個工作，接下來，我們就要把這些自動生成的規(guī)則放進(jìn)我們的主Makefile中。我們可以使用Makefile的“include”命令，來引入別的Makefile文件（前面講過），例如：

　　sources = foo.c bar.c

　　include $（sources：.c=.d）

　　上述語句中的“$（sources：.c=.d）”中的“.c=.d”的意思是做一個替換，把變量$（sources）所有［.c］的字串都替換成［.d］，關(guān)于這個“替換”的內(nèi)容，在后面我會有更為詳細(xì)的講述。當(dāng)然，你得注意次序，因為include是按次來載入文件，最先載入的［.d］文件中的目標(biāo)會成為默認(rèn)目標(biāo)。