阮一峰：Make 命令教學

程式碼變成可執行檔案，叫做編譯（compile）；先編譯這個，還是先編譯那個（即編譯的安排），叫做構建（build）。

Make是最常用的構建工具，誕生於1977年，主要用於C語言的專案。但是實際上 ，任何只要某個檔案有變化，就要重新構建的專案，都可以用Make構建。

本文介紹Make命令的用法，從簡單的講起，不需要任何基礎，只要會使用命令列，就能看懂。我的參考資料主要是Isaac Schlueter的《Makefile檔案教學》和《GNU Make手冊》。

一、Make的概念

Make這個詞，英語的意思是”製作”。Make命令直接用了這個意思，就是要做出某個檔案。比如，要做出檔案a.txt，就可以執行下面的命令。

$ make a.txt

但是，如果你真的輸入這條命令，它並不會起作用。因為Make命令本身並不知道，如何做出a.txt，需要有人告訴它，如何呼叫其他命令完成這個目標。

比如，假設檔案 a.txt 依賴於 b.txt 和 c.txt ，是後面兩個檔案連線（cat命令）的產物。那麼，make 需要知道下面的規則。

a.txt: b.txt c.txt
    cat b.txt c.txt > a.txt

也就是說，make a.txt 這條命令的背後，實際上分成兩步：第一步，確認 b.txt 和 c.txt 必須已經存在，第二步使用 cat 命令 將這個兩個檔案合併，輸出為新檔案。

像這樣的規則，都寫在一個叫做Makefile的檔案中，Make命令依賴這個檔案進行構建。Makefile檔案也可以寫為makefile， 或者用命令列引數指定為其他檔名。

$ make -f rules.txt
# 或者
$ make --file=rules.txt

上面程式碼指定make命令依據rules.txt檔案中的規則，進行構建。

總之，make只是一個根據指定的Shell命令進行構建的工具。它的規則很簡單，你規定要構建哪個檔案、它依賴哪些原始檔，當那些檔案有變動時，如何重新構建它。

二、Makefile檔案的格式

構建規則都寫在Makefile檔案裡面，要學會如何Make命令，就必須學會如何編寫Makefile檔案。

2.1 概述

Makefile檔案由一系列規則（rules）構成。每條規則的形式如下。

<target> : <prerequisites> 
[tab]  <commands>

上面第一行冒號前面的部分，叫做”目標”（target），冒號後面的部分叫做”前置條件”（prerequisites）；第二行必須由一個tab鍵起首，後面跟著”命令”（commands）。

“目標”是必需的，不可省略；”前置條件”和”命令”都是可選的，但是兩者之中必須至少存在一個。

每條規則就明確兩件事：構建目標的前置條件是什麼，以及如何構建。下面就詳細講解，每條規則的這三個組成部分。

2.2 目標（target）

一個目標（target）就構成一條規則。目標通常是檔名，指明Make命令所要構建的物件，比如上文的 a.txt 。目標可以是一個檔名，也可以是多個檔名，之間用空格分隔。

除了檔名，目標還可以是某個操作的名字，這稱為”偽目標”（phony target）。

clean:
      rm *.o

上面程式碼的目標是clean，它不是檔名，而是一個操作的名字，屬於”偽目標 “，作用是刪除物件檔案。

$ make  clean

但是，如果當前目錄中，正好有一個檔案叫做clean，那麼這個命令不會執行。因為Make發現clean檔案已經存在，就認為沒有必要重新構建了，就不會執行指定的rm命令。

為了避免這種情況，可以明確宣告clean是”偽目標”，寫法如下。

.PHONY: clean
clean:
        rm *.o temp

宣告clean是”偽目標”之後，make就不會去檢查是否存在一個叫做clean的檔案，而是每次執行都執行對應的命令。像.PHONY這樣的內建目標名還有不少，可以檢視手冊。

如果Make命令執行時沒有指定目標，預設會執行Makefile檔案的第一個目標。

$ make

上面程式碼執行Makefile檔案的第一個目標。

2.3 前置條件（prerequisites）

前置條件通常是一組檔名，之間用空格分隔。它指定了”目標”是否重新構建的判斷標準：只要有一個前置檔案不存在，或者有過更新（前置檔案的last-modification時間戳比目標的時間戳新），”目標”就需要重新構建。

result.txt: source.txt
    cp source.txt result.txt

上面程式碼中，構建 result.txt 的前置條件是 source.txt 。如果當前目錄中，source.txt 已經存在，那麼make result.txt可以正常執行，否則必須再寫一條規則，來生成 source.txt 。

source.txt:
    echo "this is the source" > source.txt

上面程式碼中，source.txt後面沒有前置條件，就意味著它跟其他檔案都無關，只要這個檔案還不存在，每次呼叫make source.txt，它都會生成。

$ make result.txt
$ make result.txt

上面命令連續執行兩次make result.txt。第一次執行會先新建 source.txt，然後再新建 result.txt。第二次執行，Make發現 source.txt 沒有變動（時間戳晚於 result.txt），就不會執行任何操作，result.txt 也不會重新生成。

如果需要生成多個檔案，往往採用下面的寫法。

source: file1 file2 file3

上面程式碼中，source 是一個偽目標，只有三個前置檔案，沒有任何對應的命令。

$ make source

執行make source命令後，就會一次性生成 file1，file2，file3 三個檔案。這比下面的寫法要方便很多。

$ make file1
$ make file2
$ make file3

2.4 命令（commands）

命令（commands）表示如何更新目標檔案，由一行或多行的Shell命令組成。它是構建”目標”的具體指令，它的執行結果通常就是生成目標檔案。

每行命令之前必須有一個tab鍵。如果想用其他鍵，可以用內建變數.RECIPEPREFIX宣告。

.RECIPEPREFIX = >
all:
> echo Hello, world

上面程式碼用.RECIPEPREFIX指定，大於號（>）替代tab鍵。所以，每一行命令的起首變成了大於號，而不是tab鍵。

需要注意的是，每行命令在一個單獨的shell中執行。這些Shell之間沒有繼承關係。

var-lost:
    export foo=bar
    echo "foo=[$$foo]"

上面程式碼執行後（make var-lost），取不到foo的值。因為兩行命令在兩個不同的進程執行。一個解決辦法是將兩行命令寫在一行，中間用分號分隔。

var-kept:
    export foo=bar; echo "foo=[$$foo]"

另一個解決辦法是在換行符前加反斜槓跳脫。

var-kept:
    export foo=bar; 
    echo "foo=[$$foo]"

最後一個方法是加上.ONESHELL:命令。

.ONESHELL:
var-kept:
    export foo=bar; 
    echo "foo=[$$foo]"

三、Makefile檔案的語法

3.1 注釋

井號（#）在Makefile中表示注釋。

# 這是注釋
result.txt: source.txt
    # 這是注釋
    cp source.txt result.txt # 這也是注釋

3.2 回聲（echoing）

正常情況下，make會列印每條命令，然後再執行，這就叫做回聲（echoing）。

test:
    # 這是測試

執行上面的規則，會得到下面的結果。

$ make test
# 這是測試

在命令的前面加上@，就可以關閉回聲。

test:
    @# 這是測試

現在再執行make test，就不會有任何輸出。

由於在構建過程中，需要了解當前在執行哪條命令，所以通常只在註釋和純顯示的echo命令前面加上@。

test:
    @# 這是測試
    @echo TODO

3.3 萬用字元

萬用字元（wildcard）用來指定一組符合條件的檔名。Makefile 的萬用字元與 Bash 一致，主要有星號（*）、問號（？）和 […] 。比如， *.o 表示所有字尾名為o的檔案。

clean:
        rm -f *.o

3.4 模式匹配

Make命令允許對檔名，進行類似正則運算的匹配，主要用到的匹配符是%。比如，假定當前目錄下有 f1.c 和 f2.c 兩個原始碼檔案，需要將它們編譯為對應的物件檔案。

%.o: %.c

等同於下面的寫法。

f1.o: f1.c
f2.o: f2.c

使用匹配符%，可以將大量同型別的檔案，只用一條規則就完成構建。

3.5 變數和賦值符

Makefile 允許使用等號自定義變數。

txt = Hello World
test:
    @echo $(txt)

上面程式碼中，變數 txt 等於 Hello World。呼叫時，變數需要放在 $( ) 之中。

呼叫Shell變數，需要在美元符號前，再加一個美元符號，這是因為Make命令會對美元符號跳脫。

test:
    @echo $$HOME

有時，變數的值可能指向另一個變數。

v1 = $(v2)

上面程式碼中，變數 v1 的值是另一個變數 v2。這時會產生一個問題，v1 的值到底在定義時擴充套件（靜態擴充套件），還是在執行時擴充套件（動態擴充套件）？如果 v2 的值是動態的，這兩種擴充套件方式的結果可能會差異很大。

為了解決類似問題，Makefile一共提供了四個賦值運算子 （=、:=、？=、+=），它們的區別請看StackOverflow。

VARIABLE = value
# 在執行時擴充套件，允許遞回擴充套件。

VARIABLE := value
# 在定義時擴充套件。

VARIABLE ?= value
# 只有在該變數為空時才設定值。

VARIABLE += value
# 將值追加到變數的尾端。

3.6 內建變數（Implicit Variables）

Make命令提供一系列內建變數，比如，$(CC) 指向當前使用的編譯器，$(MAKE) 指向當前使用的Make工具。這主要是為了跨平台的相容性，詳細的內建變數清單見手冊。

output:
    $(CC) -o output input.c

3.7 自動變數（Automatic Variables）

Make命令還提供一些自動變數，它們的值與當前規則有關。主要有以下幾個。

（1）$@

$@指代當前目標，就是Make命令當前構建的那個目標。比如，make foo的 $@ 就指代foo。

a.txt b.txt: 
    touch $@

等同於下面的寫法。

a.txt:
    touch a.txt
b.txt:
    touch b.txt

（2）$<

$< 指代第一個前置條件。比如，規則為 t: p1 p2，那麼$< 就指代p1。

a.txt: b.txt c.txt
    cp $< $@ 

等同於下面的寫法。

a.txt: b.txt c.txt
    cp b.txt a.txt 

（3）$?

$? 指代比目標更新的所有前置條件，之間以空格分隔。比如，規則為 t: p1 p2，其中 p2 的時間戳比 t 新，$?就指代p2。

（4）$^

$^ 指代所有前置條件，之間以空格分隔。比如，規則為 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）。

3.8 判斷和迴圈

Makefile使用 Bash 語法，完成判斷和迴圈。

ifeq ($(CC),gcc)
  libs=$(libs_for_gcc)
else
  libs=$(normal_libs)
endif

上面程式碼判斷當前編譯器是否 gcc ，然後指定不同的庫檔案。

LIST = one two three
all:
    for i in $(LIST); do 
        echo $$i; 
    done

# 等同於

all:
    for i in one two three; do 
        echo $i; 
    done

上面程式碼的執行結果。

one
two
three

3.9 函數

Makefile 還可以使用函數，格式如下。

$(function arguments)
# 或者
${function arguments}

Makefile提供了許多內建函數，可供呼叫。下面是幾個常用的內建函數。

（1）shell 函數

shell 函數用來執行 shell 命令

srcfiles := $(shell echo src/{00..99}.txt)

（2）wildcard 函數

wildcard 函數用來在 Makefile 中，替換 Bash 的萬用字元。

srcfiles := $(wildcard src/*.txt)

（3）替換函數

替換函數的寫法是：變數名 + 冒號 + 替換規則。

min: $(OUTPUT:.js=.min.js)

上面程式碼的意思是，將變數OUTPUT中的 .js 全部替換成 .min.js 。

四、Makefile 的範例

（1）執行多個目標

.PHONY: cleanall cleanobj cleandiff

cleanall : cleanobj cleandiff
        rm program

cleanobj :
        rm *.o

cleandiff :
        rm *.diff

上面程式碼可以呼叫不同目標，刪除不同字尾名的檔案，也可以呼叫一個目標（cleanall），刪除所有指定型別的檔案。

（2）編譯C語言專案

edit : main.o kbd.o command.o display.o 
    cc -o edit main.o kbd.o command.o display.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
    cc -c display.c

clean :
     rm edit main.o kbd.o command.o display.o

.PHONY: edit clean

今天，Make命令的介紹就到這裡。下一篇文章我會介紹，如何用 Make 來構建 Node.js 專案。

（完）