Makefile 書寫規則

1.1 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還不夠，我會之後面一點一點地結合個人工做經驗給你慢慢到來。內容還多着呢。：） 

1.2 一個示例 
正如前面所說的，若是一個工程有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中定義不用的編譯或是和編譯無關的命令，好比程序的打包，程序的備份，等等。

 

1.3 make是如何工做的 
在默認的方式下，也就是咱們只輸入make命令。那麼， 

make會在當前目錄下找名字叫「Makefile」或「makefile」的文件。 
若是找到，它會找文件中的第一個目標文件（target），在上面的例子中，他會找到「edit」這個文件，並把這個文件做爲最終的目標文件。 
若是edit文件不存在，或是edit所依賴的後面的 .o 文件的文件修改時間要比edit這個文件新，那麼，他就會執行後面所定義的命令來生成edit這個文件。 
若是edit所依賴的.o文件也存在，那麼make會在當前文件中找目標爲.o文件的依賴性，若是找到則再根據那一個規則生成.o文件。（這有點像一個堆棧的過程） 
固然，你的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會被重連接。 

1.4 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 變量就能夠了。 

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

1.5 讓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是個僞目標文件。 
關於更爲詳細的「隱晦規則」和「僞目標文件」，我會在後續給你一一道來。 

1.6 另類風格的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文件，那就理不清楚了。 
1.7 清空目標文件的規則 
每一個Makefile中都應該寫一個清空目標文件（.o和執行文件）的規則，這不只便於重編譯，也很利於保持文件的清潔。這是一個「修養」（呵呵，還記得個人《編程修養》嗎）。通常的風格都是： 
        clean: 
            rm edit $(objects) 
更爲穩健的作法是： 
        .PHONY : clean 
        clean : 
                -rm edit $(objects) 
前面說過，.PHONY意思表示clean是一個「僞目標」，。而在rm命令前面加了一個小減號的意思就是，也許某些文件出現問題，但不要管，繼續作後面的事。固然，clean的規則不要放在文件的開頭，否則，這就會變成make的默認目標，相信誰也不肯意這樣。不成文的規矩是——「clean歷來都是放在文件的最後」。 

上面就是一個makefile的概貌，也是makefile的基礎，下面還有不少makefile的相關細節，準備好了嗎？準備好了就來。

 

2 Makefile 總述 
2.1 Makefile裏有什麼？ 
Makefile裏主要包含了五個東西：顯式規則、隱晦規則、變量定義、文件指示和註釋。 

顯式規則。顯式規則說明了，如何生成一個或多的的目標文件。這是由Makefile的書寫者明顯指出，要生成的文件，文件的依賴文件，生成的命令。 
隱晦規則。因爲咱們的make有自動推導的功能，因此隱晦的規則可讓咱們比較粗糙地簡略地書寫Makefile，這是由make所支持的。 
變量的定義。在Makefile中咱們要定義一系列的變量，變量通常都是字符串，這個有點你C語言中的宏，當Makefile被執行時，其中的變量都會被擴展到相應的引用位置上。 
文件指示。其包括了三個部分，一個是在一個Makefile中引用另外一個Makefile，就像C語言中的include同樣；另外一個是指根據某些狀況指定Makefile中的有效部分，就像C語言中的預編譯#if同樣；還有就是定義一個多行的命令。有關這一部分的內容，我會在後續的部分中講述。 
註釋。Makefile中只有行註釋，和UNIX的Shell腳本同樣，其註釋是用「#」字符，這個就像C/C++中的「//」同樣。若是你要在你的Makefile中使用「#」字符，能夠用反斜框進行轉義，如：「/#」。 
最後，還值得一提的是，在Makefile中的命令，必需要以[Tab]鍵開始。 

2.2Makefile的文件名 
默認的狀況下，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。 

2.3 引用其它的Makefile 
在Makefile使用include關鍵字能夠把別的Makefile包含進來，這很像C語言的#include，被包含的文件會原模原樣的放在當前文件的包含位置。include的語法是： 
include <filename>filename能夠是當前操做系統Shell的文件模式（能夠保含路徑和通配符） 
在include前面能夠有一些空字符，可是毫不能是[Tab]鍵開始。include和能夠用一個或多個空格隔開。舉個例子，你有這樣幾個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還會在下面的幾個目錄下找： 

若是make執行時，有「-I」或「--include-dir」參數，那麼make就會在這個參數所指定的目錄下去尋找。 
若是目錄/include（通常是：/usr/local/bin或/usr/include）存在的話，make也會去找。 
若是有文件沒有找到的話，make會生成一條警告信息，但不會立刻出現致命錯誤。它會繼續載入其它的文件，一旦完成makefile的讀取，make會再重試這些沒有找到，或是不能讀取的文件，若是仍是不行，make纔會出現一條致命信息。若是你想讓make不理那些沒法讀取的文件，而繼續執行，你能夠在include前加一個減號「-」。如： 

-include <filename>其表示，不管include過程當中出現什麼錯誤，都不要報錯繼續執行。和其它版本make兼容的相關命令是sinclude，其做用和這一個是同樣的。 
2.4 環境變量 MAKEFILES 
若是你的當前環境中定義了環境變量MAKEFILES，那麼，make會把這個變量中的值作一個相似於include的動做。這個變量中的值是其它的Makefile，用空格分隔。只是，它和include不一樣的是，從這個環境變中引入的Makefile的「目標」不會起做用，若是環境變量中定義的文件發現錯誤，make也會不理。 
可是在這裏我仍是建議不要使用這個環境變量，由於只要這個變量一被定義，那麼當你使用make時，全部的Makefile都會受到它的影響，這毫不是你想看到的。在這裏提這個事，只是爲了告訴你們，也許有時候你的Makefile出現了怪事，那麼你能夠看看當前環境中有沒有定義這個變量。 

2.5 make的工做方式 
GNU的make工做時的執行步驟入下：（想來其它的make也是相似） 

讀入全部的Makefile。 
讀入被include的其它Makefile。 
初始化文件中的變量。 
推導隱晦規則，並分析全部規則。 
爲全部的目標文件建立依賴關係鏈。 
根據依賴關係，決定哪些目標要從新生成。 
執行生成命令。 
1-5步爲第一個階段，6-7爲第二個階段。第一個階段中，若是定義的變量被使用了，那麼，make會把其展開在使用的位置。但make並不會徹底立刻展開，make使用的是拖延戰術，若是變量出如今依賴關係的規則中，那麼僅當這條依賴被決定要使用了，變量纔會在其內部展開。 

固然，這個工做方式你不必定要清楚，可是知道這個方式你也會對make更爲熟悉。有了這個基礎，後續部分也就容易看懂了