Makefile 手冊(二)

Makefile總述一、Makefile裡有什麼

Makefile裡主要包含了五個東西：顯式規則、隱晦規則、變數定義、檔案指示和注釋。

1、顯式規則。顯式規則說明了，如何產生一個或多的的目標檔案。這是由Makefile的書寫者明顯指出，要產生的檔案，檔案的依賴檔案，產生的命令。

2、隱晦規則。由於我們的make有自動推導的功能，所以隱晦的規則可以讓我們比較粗糙地簡略地書寫Makefile，這是由make所支援的。

3、變數的定義。在Makefile中我們要定義一系列的變數，變數一般都是字串，這個有點像你C語言中的宏，當Makefile被執行時，其中的變數都會被擴充到相應的引用位置上。

4、檔案指示。其包括了三個部分，一個是在一個Makefile中引用另一個Makefile，就像C語言中的include一樣；另一個是指根據某些情況指定Makefile中的有效部分，就像C語言中的先行編譯#if一樣；還有就是定義一個多行的命令。有關這一部分的內容，我會在後續的部分中講述。

5、注釋。Makefile中只有行注釋，和UNIX的Shell指令碼一樣，其注釋是用“#”字元，這個就像C/C++中的“//”一樣。如果你要在你的Makefile中使用“#”字元，可以用反斜框進行轉義，如：“\#”。

最後，還值得一提的是，在Makefile中的命令，必須要以[Tab]鍵開始。

二、Makefile的檔案名稱

預設的情況下，make命令會在目前的目錄下按順序找尋檔案名稱為“GNUmakefile”、“makefile”、“Makefile”的檔案，找到瞭解釋這個檔案。在這三個檔案名稱中，最好使用“Makefile”這個檔案名稱，因為，這個檔案名稱第一個字元為大寫，這樣有一種顯目的感覺。最好不要用 “GNUmakefile”，這個檔案是GNU的make識別的。有另外一些make只對全小寫“makefile”檔案名稱敏感，但是基本上來說，大多數的make都支援“makefile”和“Makefile”這兩種預設檔案名稱。

當然，你可以使用別的檔案名稱來書寫Makefile，比如：“Make.Linux”，“Make.Solaris”，“Make.AIX”等，如果要指定特定的Makefile，你可以使用make的“- f”和“--file”參數，如：make -f Make.Linux或make --file Make.AIX。

三、引用其它的Makefile

在Makefile使用include關鍵字可以把別的Makefile包含進來，這很像C語言的#include，被包含的檔案會原模原樣的放在當前檔案的包含位置。include的文法是：

include <filename>

filename可以是當前作業系統Shell的檔案模式（可以保含路徑和萬用字元）

在 include前面可以有一些Null 字元，但是絕不能是[Tab]鍵開始。include和<filename>可以用一個或多個空格隔開。舉個例子，你有這樣幾個Makefile：a.mk、b.mk、c.mk，還有一個檔案叫foo.make，以及一個變數$(bar)，其包含了e.mk和 f.mk，那麼，下面的語句：

include foo.make *.mk $(bar)

等價於：

include foo.make a.mk b.mk c.mk e.mk f.mk

make 命令開始時，會把找尋include所指出的其它Makefile，並把其內容安置在當前的位置。就好像C/C++的#include指令一樣。如果檔案都沒有指定絕對路徑或是相對路徑的話，make會在目前的目錄下首先尋找，如果目前的目錄下沒有找到，那麼，make還會在下面的幾個目錄下找：

1、如果make執行時，有“-I”或“--include-dir”參數，那麼make就會在這個參數所指定的目錄下去尋找。

2、如果目錄<prefix>/include（一般是：/usr/local/bin或/usr/include）存在的話，make也會去找。

如果有檔案沒有找到的話，make會產生一條警告資訊，但不會馬上出現致命錯誤。它會繼續載入其它的檔案，一旦完成makefile的讀取，make會再重試這些沒有找到，或是不能讀取的檔案，如果還是不行，make才會出現一條致命資訊。如果你想讓make不理那些無法讀取的檔案，而繼續執行，你可以在 include前加一個減號“-”。如：

-include <filename>

其表示，無論include過程中出現什麼錯誤，都不要報錯繼續執行。和其它版本make相容的相關命令是sinclude，其作用和這一個是一樣的。

四、環境變數 MAKEFILES

如果你的當前環境中定義了環境變數MAKEFILES，那麼，make會把這個變數中的值做一個類似於include的動作。這個變數中的值是其它的 Makefile，用空格分隔。只是，它和include不同的是，從這個環境變中引入的Makefile的“目標”不會起作用，如果環境變數中定義的檔案發現錯誤，make也會不理。

但是在這裡我還是建議不要使用這個環境變數，因為只要這個變數一被定義，那麼當你使用make時，所有的 Makefile都會受到它的影響，這絕不是你想看到的。在這裡提這個事，只是為了告訴大家，也許有時候你的Makefile出現了怪事，那麼你可以看看當前環境中有沒有定義這個變數。

五、make的工作方式

GNU的make工作時的執行步驟入下：（想來其它的make也是類似）

1、讀入所有的Makefile。

2、讀入被include的其它Makefile。

3、初始設定檔案中的變數。

4、推導隱晦規則，並分析所有規則。

5、為所有的目標檔案建立依賴關係鏈。

6、根據依賴關係，決定哪些目標要重建。

7、執行產生命令。

1-5 步為第一個階段，6-7為第二個階段。第一個階段中，如果定義的變數被使用了，那麼，make會把其展開在使用的位置。但make並不會完全馬上展開，make使用的是拖延戰術，如果變數出現在依賴關係的規則中，那麼僅當這條依賴被決定要使用了，變數才會在其內部展開。

當然，這個工作方式你不一定要清楚，但是知道這個方式你也會對make更為熟悉。有了這個基礎，後續部分也就容易看懂了。

書寫規則

規則包含兩個部分，一個是依賴關係，一個是產生目標的方法。

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

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

一、規則舉例

foo.o : foo.c defs.h # foo模組

cc -c -g foo.c

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

1、檔案的依賴關係，foo.o依賴於foo.c和defs.h的檔案，如果foo.c和defs.h的檔案日期要比foo.o檔案日期要新，或是foo.o不存在，那麼依賴關係發生。

2、如果產生（或更新）foo.o檔案。也就是那個cc命令，其說明了，如何產生foo.o這個檔案。（當然foo.c檔案include了defs.h檔案）

二、規則的文法

targets : prerequisites

command

...

或是這樣：

targets : prerequisites ; command

command

...

targets是檔案名稱，以空格分開，可以使用萬用字元。一般來說，我們的目標基本上是一個檔案，但也有可能是多個檔案。

command是命令列，如果其不與“target吐舌rerequisites”在一行，那麼，必須以[Tab鍵]開頭，如果和prerequisites在一行，那麼可以用分號做為分隔。（見上）prerequisites也就是目標所依賴的檔案（或依賴目標）。如果其中的某個檔案要比目標檔案要新，那麼，目標就被認為是“過時的”，被認為是需要重產生的。這個在前面已經講過了。

如果命令太長，你可以使用反斜框（‘\’）作為分行符號。make對一行上有多少個字元沒有限制。規則告訴make兩件事，檔案的依賴關係和如何成成目標檔案。

一般來說，make會以UNIX的標準Shell，也就是/bin/sh來執行命令。

三、在規則中使用萬用字元

如果我們想定義一系列比較類似的檔案，我們很自然地就想起使用萬用字元。make支援三各萬用字元：“*”，“?”和“[...]”。這是和Unix的B-Shell是相同的。

波浪號（“~”）字元在檔案名稱中也有比較特殊的用途。如果是“~/test”，這就表示目前使用者的$HOME目錄下的test目錄。而“~hchen /test”則表示使用者hchen的宿主目錄下的test目錄。（這些都是Unix下的小知識了，make也支援）而在Windows或是MS-DOS 下，使用者沒有宿主目錄，那麼波浪號所指的目錄則根據環境變數“HOME”而定。

萬用字元代替了你一系列的檔案，如“*.c”表示所以尾碼為c的檔案。一個需要我們注意的是，如果我們的檔案名稱中有萬用字元，如：“*”，那麼可以用逸出字元“\”，如“\*”來表示真實的“*”字元，而不是任意長度的字串。

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

clean:

rm -f *.o

上面這個例子我不不多說了，這是作業系統Shell所支援的萬用字元。這是在命令中的萬用字元。

print: *.c

lpr -p $?

touch print

上面這個例子說明了萬用字元也可以在我們的規則中，目標print依賴於所有的[.c]檔案。其中的“$?”是一個自動化變數，我會在後面給你講述。

objects = *.o

上面這個例子，表示了，通符同樣可以用在變數中。並不是說[*.o]會展開，不！objects的值就是“*.o”。Makefile中的變數其實就是 C/C++中的宏。如果你要讓萬用字元在變數中展開，也就是讓objects的值是所有[.o]的檔案名稱的集合，那麼，你可以這樣：

objects := $(wildcard *.o)

這種用法由關鍵字“wildcard”指出，關於Makefile的關鍵字，我們將在後面討論。

四、檔案搜尋

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

Makefile檔案中的特殊變數“VPATH”就是完成這個功能的，如果沒有指明這個變數，make只會在當前的目錄中去找尋依賴檔案和目標檔案。如果定義了這個變數，那麼make就會在噹噹前目錄找不到的情況下，到所指定的目錄中去找尋檔案了。

VPATH = src:../headers

上面的的定義指定兩個目錄，“src”和“../headers”，make會按照這個順序進行搜尋。目錄由“冒號”分隔。（當然，目前的目錄永遠是最高優先搜尋的地方）

另一個設定檔案搜尋路徑的方法是使用make的“vpath”關鍵字（注意，它是全小寫），這不是變數，這是一個make的關鍵字，這和上面提到的那個 VPATH變數很類似，但是它更為靈活。它可以指定不同的檔案在不同的搜尋目錄中。這是一個很靈活的功能。它的使用方法有三種：

1、vpath <pattern> <directories>為符合模式<pattern>的檔案指定搜尋目錄<directories>。

2、vpath <pattern>清除符合模式<pattern>的檔案的搜尋目錄。

3、vpath清除所有已被設定好了的檔案搜尋目錄。

vapth 使用方法中的<pattern>需要包含“%”字元。“%”的意思是匹配零或若干字元，例如，“%.h”表示所有以“.h”結尾的檔案。<pattern>指定了要搜尋的檔案集，而<directories>則指定了<pattern>的檔案集的搜尋的目錄。例如：

vpath %.h ../headers

該語句表示，要求make在“../headers”目錄下搜尋所有以“.h”結尾的檔案。（如果某檔案在目前的目錄沒有找到的話）我們可以連續地使用vpath語句，以指定不同搜尋策略。如果連續的vpath語句中出現了相同的<pattern>，或是被重複了的<pattern>，那麼，make會按照vpath語句的先後順序來執行搜尋。如：

vpath %.c foo

vpath % blish

vpath %.c bar

其表示“.c”結尾的檔案，先在“foo”目錄，然後是“blish”，最後是“bar”目錄。

vpath %.c foo:bar

vpath % blish

而上面的語句則表示“.c”結尾的檔案，先在“foo”目錄，然後是“bar”目錄，最後才是“blish”目錄。

五、偽目標

最早先的一個例子中，我們提到過一個“clean”的目標，這是一個“偽目標”：

clean:

rm *.o temp

正像我們前面例子中的“clean”一樣，即然我們產生了許多檔案編譯檔案，我們也應該提供一個清除它們的“目標”以備完整地重編譯而用。（以“make clean”來使用該目標）因為，我們並不產生“clean”這個檔案。“偽目標”並不是一個檔案，只是一個標籤，由於“偽目標”不是檔案，所以make無法產生它的依賴關係和決定它是否要執行。我們只有通過顯示地指明這個“目標”才能讓其生效。當然，“偽目標”的取名不能和檔案名稱重名，不然其就失去了“偽目標”的意義了。

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

.PHONY : clean

只要有這個聲明，不管是否有“clean”檔案，要運行“clean”這個目標，只有“make clean”這樣。於是整個過程可以這樣寫：

.PHONY: clean

clean:

rm *.o temp

偽目標一般沒有依賴的檔案。但是，我們也可以為偽目標指定所依賴的檔案。偽目標同樣可以作為“預設目標”，只要將其放在第一個。一個樣本就是，如果你的 Makefile需要一口氣產生若干個可執行檔，但你只想簡單地敲一個make完事，並且，所有的目標檔案都寫在一個Makefile中，那麼你可以使用“偽目標”這個特性：

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中的第一個目標會被作為其預設目標。我們聲明了一個“all”的偽目標，其依賴於其它三個目標。由於偽目標的特性是，總是被執行的，所以其依賴的那三個目標就總是不如“all”這個目標新。所以，其它三個目標的規則總是會被決議。也就達到了我們一口氣產生多個目標的目的。 “.PHONY : all”聲明了“all”這個目標為“偽目標”。

隨便提一句，從上面的例子我們可以看出，目標也可以成為依賴。所以，偽目標同樣也可成為依賴。看下面的例子：

.PHONY: cleanall cleanobj cleandiff

cleanall : cleanobj cleandiff

rm program

cleanobj :

rm *.o

cleandiff :

rm *.diff

“make clean”將清除所有要被清除的檔案。“cleanobj”和“cleandiff”這兩個偽目標有點像“子程式”的意思。我們可以輸入“make cleanall”和“make cleanobj”和“make cleandiff”命令來達到清除不同種類檔案的目的。

六、多目標

Makefile 的規則中的目標可以不止一個，其支援多目標，有可能我們的多個目標同時依賴於一個檔案，並且其產生的命令大體類似。於是我們就能把其合并起來。當然，多個目標的建置規則的執行命令是同一個，這可能會可我們帶來麻煩，不過好在我們的可以使用一個自動化變數“$@”（關於自動化變數，將在後面講述），這個變數表示著目前規則中所有的目標的集合，這樣說可能很抽象，還是看一個例子吧。

bigoutput littleoutput : text.g

generate text.g -$(subst output,,$@) > $@

上述規則等價於：

bigoutput : text.g

generate text.g -big > bigoutput

littleoutput : text.g

generate text.g -little > littleoutput

其中，-$(subst output,,$@)中的“$”表示執行一個Makefile的函數，函數名為subst，後面的為參數。關於函數，將在後面講述。這裡的這個函數是截取字串的意思，“$@”表示目標的集合，就像一個數組，“$@”依次取出目標，並執於命令。

七、靜態模式

靜態模式可以更加容易地定義多目標的規則，可以讓我們的規則變得更加的有彈性和靈活。我們還是先來看一下文法：

<targets ...>: <target-pattern>: <prereq-patterns ...>

<commands>

...

targets定義了一系列的目標檔案，可以有萬用字元。是目標的一個集合。

target-parrtern是指明了targets的模式，也就是的目的地組模式。

prereq-parrterns是目標的依賴模式，它對target-parrtern形成的模式再進行一次依賴目標的定義。

這樣描述這三個東西，可能還是沒有說清楚，還是舉個例子來說明一下吧。如果我們的<target-parrtern>定義成“%.o”，意思是我們的<target>集合中都是以“.o”結尾的，而如果我們的<prereq-parrterns>定義成“%.c”，意思是對<target-parrtern>所形成的目的地組進行二次定義，其計算方法是，取<target-parrtern>模式中的“%”（也就是去掉了[.o]這個結尾），並為其加上[.c]這個結尾，形成的新集合。

所以，我們的“目標模式”或是“依賴模式”中都應該有“%”這個字元，如果你的檔案名稱中有“%”那麼你可以使用反斜線“\”進行轉義，來標明真實的“%”字元。

看一個例子：

objects = foo.o bar.o

all: $(objects)

$(objects): %.o: %.c

$(CC) -c $(CFLAGS) $< -o $@

上面的例子中，指明了我們的目標從$object中擷取，“%.o”表明要所有以“.o”結尾的目標，也就是“foo.o bar.o”，也就是變數$object集合的模式，而依賴模式“%.c”則模數式“%.o”的“%”，也就是“foo bar”，並為其加下“.c”的尾碼，於是，我們的依賴目標就是“foo.c bar.c”。而命令中的“$<”和“$@”則是自動化變數，“$<”表示所有的依賴目的地組（也就是“foo.c bar.c”），“$@”表示目的地組（也就是“foo.o bar.o”）。於是，上面的規則展開後等價於下面的規則：

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”有幾百個，那種我們只要用這種很簡單的“靜態模式規則”就可以寫完一堆規則，實在是太有效率了。“靜態模式規則”的用法很靈活，如果用得好，那會一個很強大的功能。再看一個例子：

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))表示調用Makefile的filter函數，過濾“$filter”集，只要其中模式為“%.o”的內容。其的它內容，我就不用多說了吧。這個例字展示了Makefile中更大的彈性。

八、自動產生依賴性

在Makefile中，我們的依賴關係可能會需要包含一系列的標頭檔，比如，如果我們的main.c中有一句“#include "defs.h"”，那麼我們的依賴關係應該是：

main.o : main.c defs.h

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

cc -M main.c

其輸出是：

main.o : main.c defs.h

於是由編譯器自動產生的依賴關係，這樣一來，你就不必再手動書寫若干檔案的依賴關係，而由編譯器自動產生了。需要提醒一句的是，如果你使用GNU的C/C++編譯器，你得用“-MM”參數，不然，“-M”參數會把一些標準庫的標頭檔也包含進來。

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聯絡在一起呢。因為這樣一來，我們的Makefile也要根據這些源檔案重建，讓Makefile 自已依賴於源檔案？這個功能並不現實，不過我們可以有其它手段來迂迴地實現這一功能。GNU組織建議把編譯器為每一個源檔案的自動產生的依賴關係放到一個檔案中，為每一個“name.c”的檔案都產生一個“name.d”的Makefile檔案，[.d]檔案中就存放對應[.c]檔案的依賴關係。

於是，我們可以寫出[.c]檔案和[.d]檔案的依賴關係，並讓make自動更新或自成[.d]檔案，並把其包含在我們的主Makefile中，這樣，我們就可以自動化地產生每個檔案的依賴關係了。

這裡，我們給出了一個模式規則來產生[.d]檔案：

%.d: %.c

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

$(CC) -M $(CPPFLAGS) $< > $@.$$$$; \

sed 's,\($*\)\.o[ :]*,\1.o $@ : ,g' < $@.$$$$ > $@; \

rm -f $@.$$$$

這個規則的意思是，所有的[.d]檔案依賴於[.c]檔案，“rm -f $@”的意思是刪除所有的目標，也就是[.d]檔案，第二行的意思是，為每個依賴檔案“$<”，也就是[.c]檔案產生依賴檔案，“$@”表示模式 “%.d”檔案，如果有一個C檔案是name.c，那麼“%”就是“name”，“$$$$”意為一個隨機編號，第二行產生的檔案有可能是 “name.d.12345”，第三行使用sed命令做了一個替換，關於sed命令的用法請參看相關的使用文檔。第四行就是刪除臨時檔案。

總而言之，這個模式要做的事就是在編譯器產生的依賴關係中加入[.d]檔案的依賴，即把依賴關係：

main.o : main.c defs.h

轉成：

main.o main.d : main.c defs.h

於是，我們的[.d]檔案也會自動更新了，並會自動產生了，當然，你還可以在這個[.d]檔案中加入的不只是依賴關係，包括產生的命令也可一併加入，讓每個 [.d]檔案都包含一個完賴的規則。一旦我們完成這個工作，接下來，我們就要把這些自動產生的規則放進我們的主Makefile中。我們可以使用 Makefile的“include”命令，來引入別的Makefile檔案（前面講過），例如：

sources = foo.c bar.c

include $(sources:.c=.d)

上述語句中的“$(sources:.c=.d)”中的“.c=.d”的意思是做一個替換，把變數$(sources)所有[.c]的字串都替換成 [.d]，關於這個“替換”的內容，在後面我會有更為詳細的講述。當然，你得注意次序，因為include是按次來載入檔案，最先載入的[.d]檔案中的目標會成為預設目標。