Linux 如何寫makefile檔案

關於程式的編譯和連結 
—————————— 

在此，我想多說關於程式編譯的一些規範和方法，一般來說，無論是C、C++、還是pas，首先要把源檔案編譯成中間代碼檔案，在Windows下也就是 .obj 檔案，UNIX下是 .o 檔案，即 Object File，這個動作叫做編譯（compile）。然後再把大量的Object File合成執行檔案，這個動作叫作連結（link）。 

編譯時間，編譯器需要的是文法的正確，函數與變數的聲明的正確。對於後者，通常是你需要告訴編譯器標頭檔的所在位置（標頭檔中應該只是聲明，而定義應該放在 C/C++檔案中），只要所有的文法正確，編譯器就可以編譯出中間目標檔案。一般來說，每個源檔案都應該對應於一個中間目標檔案（O檔案或是OBJ文 件）。 

連結時，主要是連結函數和全域變數，所以，我們可以使用這些中間目標檔案（O檔案或是OBJ檔案）來連結我們的應用程式。連結器並不管函數所在的源檔案， 只管函數的中間目標檔案（Object File），在大多數時候，由於源檔案太多，編譯產生的中間目標檔案太多，而在連結時需要明顯地指出中間目標檔案名，這對於編譯很不方便，所以，我們要給 中間目標檔案打個包，在Windows下這種包叫“庫檔案”（Library File)，也就是 .lib 檔案，在UNIX下，是Archive File，也就是 .a 檔案。 

總結一下，源檔案首先會產生中間目標檔案，再由中間目標檔案產生執行檔案。在編譯時間，編譯器只檢測程式文法，和函數、變數是否被聲明。如果函數未被聲明， 編譯器會給出一個警告，但可以產生Object File。而在連結程式時，連結器會在所有的Object File中找尋函數的實現，如果找不到，那到就會報連結錯誤碼（Linker Error），在VC下，這種錯誤一般是：Link 2001錯誤，意思說是說，連結器未能找到函數的實現。你需要指定函數的Object File. 

好，言歸正傳，GNU的make有許多的內容，閑言少敘，還是讓我們開始吧。 

Makefile 介紹 
——————— 

make命令執行時，需要一個 Makefile 檔案，以告訴make命令需要怎麼樣的去編譯和連結程式。 

首先，我們用一個樣本來說明Makefile的書寫規則。以便給大家一個感興認識。這個樣本來源於GNU的make使用手冊，在這個樣本中，我們的工程有 8個C檔案，和3個標頭檔，我們要寫一個Makefile來告訴make命令如何編譯和連結這幾個檔案。我們的規則是： 
     1）如果這個工程沒有編譯過，那麼我們的所有C檔案都要編譯並被連結。 
     2）如果這個工程的某幾個C檔案被修改，那麼我們只編譯被修改的C檔案，並連結目標程式。 
     3）如果這個工程的標頭檔被改變了，那麼我們需要編譯引用了這幾個標頭檔的C檔案，並連結目標程式。 

只要我們的Makefile寫得夠好，所有的這一切，我們只用一個make命令就可以完成，make命令會自動智能地根據當前的檔案修改的情況來確定哪些檔案需要重編譯，從而自己編譯所需要的檔案和連結目標程式。 

一、Makefile的規則 

在講述這個Makefile之前，還是讓我們先來粗略地看一看Makefile的規則。 

     target ... : prerequisites ... 
             command 
             ... 
             ... 

     target也就是一個目標檔案，可以是Object File，也可以是執行檔案。還可以是一個標籤（Label），對於標籤這種特性，在後續的“偽目標”章節中會有敘述。 

     prerequisites就是，要產生那個target所需要的檔案或是目標。 

     command也就是make需要執行的命令。（任意的Shell命令） 

這是一個檔案的依賴關係，也就是說，target這一個或多個的目標檔案依賴於prerequisites中的檔案，其建置規則定義在command中。 說白一點就是說，prerequisites中如果有一個以上的檔案比target檔案要新的話，command所定義的命令就會被執行。這就是 Makefile的規則。也就是Makefile中最核心的內容。 

說到底，Makefile的東西就是這樣一點，好像我的這篇文檔也該結束了。呵呵。還不盡然，這是Makefile的主線和核心，但要寫好一個Makefile還不夠，我會以後面一點一點地結合我的工作經驗給你慢慢到來。內容還多著呢。：） 

二、一個樣本 

正如前面所說的，如果一個工程有3個標頭檔，和8個C檔案，我們為了完成前面所述的那三個規則，我們的Makefile應該是下面的這個樣子的。 

     edit : main.o kbd.o command.o display.o \ 
            insert.o search.o files.o utils.o 
             cc -o edit main.o kbd.o command.o display.o \ 
                        insert.o search.o files.o utils.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 buffer.h 
             cc -c display.c 
     insert.o : insert.c defs.h buffer.h 
             cc -c insert.c 
     search.o : search.c defs.h buffer.h 
             cc -c search.c 
     files.o : files.c defs.h buffer.h command.h 
             cc -c files.c 
     utils.o : utils.c defs.h 
             cc -c utils.c 
     clean : 
             rm edit main.o kbd.o command.o display.o \ 
                insert.o search.o files.o utils.o 

反斜線（\）是分行符號的意思。這樣比較便於Makefile的易讀。我們可以把這個內容儲存在檔案為“Makefile”或“makefile”的檔案 中，然後在該目錄下直接輸入命令“make”就可以產生執行檔案edit。如果要刪除執行檔案和所有的中間目標檔案，那麼，只要簡單地執行一下“make clean”就可以了。 

在這個makefile中，目標檔案（target）包含：執行檔案edit和中間目標檔案（*.o），依賴檔案（prerequisites）就是冒號 後面的那些 .c 檔案和 .h檔案。每一個 .o 檔案都有一組依賴檔案，而這些 .o 檔案又是執行檔案 edit 的依賴檔案。依賴關係的實質上就是說明了目標檔案是由哪些檔案產生的，換言之，目標檔案是哪些檔案更新的。 

在定義好依賴關係後，後續的那一行定義了如何產生目標檔案的作業系統命令，一定要以一個Tab鍵作為開頭。記住，make並不管命令是怎麼工作的，他只管 執行所定義的命令。make會比較targets檔案和prerequisites檔案的修改日期，如果prerequisites檔案的日期要比 targets檔案的日期要新，或者target不存在的話，那麼，make就會執行後續定義的命令。 

這裡要說明一點的是，clean不是一個檔案，它只不過是一個動作名字，有點像C語言中的lable一樣，其冒號後什麼也沒有，那麼，make就不會自動 去找檔案的依賴性，也就不會自動執行其後所定義的命令。要執行其後的命令，就要在make命令後明顯得指出這個lable的名字。這樣的方法非常有用，我 們可以在一個makefile中定義不用的編譯或是和編譯無關的命令，比如程式的打包，程式的備份，等等。

三、make是如何工作的 

在預設的方式下，也就是我們只輸入make命令。那麼， 

     1、make會在目前的目錄下找名字叫“Makefile”或“makefile”的檔案。 
     2、如果找到，它會找檔案中的第一個目標檔案（target），在上面的例子中，他會找到“edit”這個檔案，並把這個檔案作為最終的目標檔案。 
     3、如果edit檔案不存在，或是edit所依賴的後面的 .o 檔案的檔案修改時間要比edit這個檔案新，那麼，他就會執行後面所定義的命令來產生edit這個檔案。 
     4、如果edit所依賴的.o檔案也存在，那麼make會在當前檔案中找目標為.o檔案的依賴性，如果找到則再根據那一個規則產生.o檔案。（這有點像一個堆棧的過程） 
     5、當然，你的C檔案和H檔案是存在的啦，於是make會產生 .o 檔案，然後再用 .o 檔案生命make的終極任務，也就是執行檔案edit了。 

這就是整個make的依賴性，make會一層又一層地去找檔案的依賴關係，直到最終編譯出第一個目標檔案。在找尋的過程中，如果出現錯誤，比如最後被依賴 的檔案找不到，那麼make就會直接退出，並報錯，而對於所定義的命令的錯誤，或是編譯不成功，make根本不理。make只管檔案的依賴性，即，如果在 我找了依賴關係之後，冒號後面的檔案還是不在，那麼對不起，我就不工作啦。 

通過上述分析，我們知道，像clean這種，沒有被第一個目標檔案直接或間接關聯，那麼它後面所定義的命令將不會被自動執行，不過，我們可以顯示要make執行。即命令——“make clean”，以此來清除所有的目標檔案，以便重編譯。 

於是在我們編程中，如果這個工程已被編譯過了，當我們修改了其中一個源檔案，比如file.c，那麼根據我們的依賴性，我們的目標file.o會被重編譯 （也就是在這個依性關係後面所定義的命令），於是file.o的檔案也是最新的啦，於是file.o的檔案修改時間要比edit要新，所以edit也會被 重新連結了（詳見edit目標檔案後定義的命令）。 

而如果我們改變了“command.h”，那麼，kdb.o、command.o和files.o都會被重編譯，並且，edit會被重連結。 

四、makefile中使用變數 

在上面的例子中，先讓我們看看edit的規則： 

       edit : main.o kbd.o command.o display.o \ 
                   insert.o search.o files.o utils.o 
             cc -o edit main.o kbd.o command.o display.o \ 
                        insert.o search.o files.o utils.o 

我們可以看到[.o]檔案的字串被重複了兩次，如果我們的工程需要加入一個新的[.o]檔案，那麼我們需要在兩個地方加（應該是三個地方，還有一個地方 在clean中）。當然，我們的makefile並不複雜，所以在兩個地方加也不累，但如果makefile變得複雜，那麼我們就有可能會忘掉一個需要加 入的地方，而導致編譯失敗。所以，為了makefile的易維護，在makefile中我們可以使用變數。makefile的變數也就是一個字串，理解 成C語言中的宏可能會更好。 

比如，我們聲明一個變數，叫objects, OBJECTS, objs, OBJS, obj, 或是 OBJ，反正不管什麼啦，只要能夠表示obj檔案就行了。我們在makefile一開始就這樣定義： 

      objects = main.o kbd.o command.o display.o \ 
               insert.o search.o files.o utils.o 

於是，我們就可以很方便地在我們的makefile中以“$(objects)”的方式來使用這個變數了，於是我們的改良版makefile就變成下面這個樣子： 

     objects = main.o kbd.o command.o display.o \ 
               insert.o search.o files.o utils.o 

     edit : $(objects) 
             cc -o edit $(objects) 
     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 buffer.h 
             cc -c display.c 
     insert.o : insert.c defs.h buffer.h 
             cc -c insert.c 
     search.o : search.c defs.h buffer.h 
             cc -c search.c 
     files.o : files.c defs.h buffer.h command.h 
             cc -c files.c 
     utils.o : utils.c defs.h 
             cc -c utils.c 
     clean : 
             rm edit $(objects) 

於是如果有新的 .o 檔案加入，我們只需簡單地修改一下 objects 變數就可以了。 

關於變數更多的話題，我會在後續給你一一道來。 

五、讓make自動推導 

GNU的make很強大，它可以自動推導檔案以及檔案依賴關係後面的命令，於是我們就沒必要去在每一個[.o]檔案後都寫上類似的命令，因為，我們的make會自動識別，並自己推導命令。 

只要make看到一個[.o]檔案，它就會自動的把[.c]檔案加在依賴關係中，如果make找到一個whatever.o，那麼whatever.c， 就會是whatever.o的依賴檔案。並且 cc -c whatever.c 也會被推匯出來，於是，我們的makefile再也不用寫得這麼複雜。我們的是新的makefile又出爐了。 

     objects = main.o kbd.o command.o display.o \ 
               insert.o search.o files.o utils.o 

     edit : $(objects) 
             cc -o edit $(objects) 

     main.o : defs.h 
     kbd.o : defs.h command.h 
     command.o : defs.h command.h 
     display.o : defs.h buffer.h 
     insert.o : defs.h buffer.h 
     search.o : defs.h buffer.h 
     files.o : defs.h buffer.h command.h 
     utils.o : defs.h 

     .PHONY : clean 
     clean : 
             rm edit $(objects) 

這種方法，也就是make的“隱晦規則”。上面檔案內容中，“.PHONY”表示，clean是個偽目標檔案。 

關於更為詳細的“隱晦規則”和“偽目標檔案”，我會在後續給你一一道來。 

六、另類風格的makefile 

即然我們的make可以自動推導命令，那麼我看到那堆[.o]和[.h]的依賴就有點不爽，那麼多的重複的[.h]，能不能把其收攏起來，好吧，沒有問題，這個對於make來說很容易，誰叫它提供了自動推導命令和檔案的功能呢？來看看最新風格的makefile吧。 

     objects = main.o kbd.o command.o display.o \ 
               insert.o search.o files.o utils.o 

     edit : $(objects) 
             cc -o edit $(objects) 

     $(objects) : defs.h 
     kbd.o command.o files.o : command.h 
     display.o insert.o search.o files.o : buffer.h 

     .PHONY : clean 
     clean : 
             rm edit $(objects) 

這種風格，讓我們的makefile變得很簡單，但我們的檔案依賴關係就顯得有點淩亂了。魚和熊掌不可兼得。還看你的喜好了。我是不喜歡這種風格的，一是檔案的依賴關係看不清楚，二是如果檔案一多，要加入幾個新的.o檔案，那就理不清楚了。 

七、清空目標檔案的規則 

每個Makefile中都應該寫一個清空目標檔案（.o和執行檔案）的規則，這不僅便於重編譯，也很利於保持檔案的清潔。這是一個“修養”（呵呵，還記得我的《編程修養》嗎）。一般的風格都是： 

         clean: 
             rm edit $(objects) 

更為穩健的做法是： 

         .PHONY : clean 
         clean : 
                 -rm edit $(objects) 

前面說過，.PHONY意思表示clean是一個“偽目標”，。而在rm命令前面加了一個小減號的意思就是，也許某些檔案出現問題，但不要管，繼續做後面 的事。當然，clean的規則不要放在檔案的開頭，不然，這就會變成make的預設目標，相信誰也不願意這樣。不成文的規矩是——“clean從來都是放 在檔案的最後”。