Make 教程

Make 命令教程

原文做者: 阮一峯html

原文連接:http://www.ruanyifeng.com/blog/2015/02/make.htmlnode

(在原文基礎上稍做修改)git

 

代碼變成可執行文件,叫作編譯(compile);先編譯這個,仍是先編譯那個(即編譯的安排),叫作構建(build)github

Make是最經常使用的構建工具,誕生於1977年,主要用於C語言的項目。可是實際上 ,任何只要某個文件有變化,就要從新構建的項目,均可以用Make構建。shell

本文介紹Make命令的用法,從簡單的講起,不須要任何基礎,只要會使用命令行,就能看懂。個人參考資料主要是Isaac Schlueter的《Makefile文件教程》《GNU Make手冊》函數

(題圖:攝於博茲賈阿達島,土耳其,2013年7月)工具

 

1、Make的概念


 

Make這個詞,英語的意思是"製做"。Make命令直接用了這個意思,就是要作出某個文件。好比,要作出文件a.txt,就能夠執行下面的命令。測試

$ make a.txt

可是,若是你真的輸入這條命令,它並不會起做用。由於Make命令自己並不知道,如何作出a.txt,須要有人告訴它,如何調用其餘命令完成這個目標。ui

好比,假設文件 a.txt 依賴於 b.txt 和 c.txt ,是後面兩個文件鏈接(cat命令)的產物。那麼,make 須要知道下面的規則。this

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命令進行構建的工具。它的規則很簡單,你規定要構建哪一個文件、它依賴哪些源文件,當那些文件有變更時,如何從新構建它。

 

2、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,它都會生成。

若是須要生成多個文件,每每採用下面的寫法。

source: file1 file2 file3

上面代碼中,source 是一個僞目標,只有三個前置文件,沒有任何對應的命令。

$ make source

執行make source命令後,就會一次性生成 file1,file2,file3 三個文件。這比下面的寫法要方便不少。

$ make file1
$ make file2
$ make file3

2.4 命令(command)

命令(commands)表示如何更新目標文件,由一行或多行的Shell命令組成。它是構建"目標"的具體指令,它的運行結果一般就是生成目標文件。

每行命令以前必須有一個tab鍵。若是想用其餘鍵,能夠用內置變量.RECIPEPREFIX聲明。

.RECIPEPREFIX = >
all:
> echo Hello, world

(PS: 變量.RECIPEPREFIX只支持make 3.82及之後的版本,查看make版本信息可用:make -v)

上面代碼用.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]"

 

3、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

(PS: 這裏的 $$就至關於$(),直接在shell窗口中查看變量可使用$HOME, 可是在makefile中要用 $$HOME,或者 $(HOME))

有時,變量的值可能指向另外一個變量。

v1 = $(v2)

上面代碼中,變量 v1 的值是另外一個變量 v2。這時會產生一個問題,v1 的值到底在定義時擴展(靜態擴展),仍是在運行時擴展(動態擴展)?若是 v2 的值是動態的,這兩種擴展方式的結果可能會差別很大。

爲了解決相似問題,Makefile一共提供了四個賦值運算符 (=、:=、?=、+=),它們的區別請看StackOverflow

VARIABLE = value
# value能夠未定義

VARIABLE := value
# 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}

(PS: 嘗試輸出srcfiles的值,可是沒有任何結果?)

 (2)wildcard 函數

wildcard 函數用來在 Makefile 中,替換 Bash 的通配符。

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

 (3)subst 函數

subst 函數用來文本替換,格式以下。

$(subst from,to,text) 

下面的例子將字符串"feet on the street"替換成"fEEt on the strEEt"。

$(subst ee,EE,feet on the street)

下面是一個稍微複雜的例子。

comma:= ,
empty:=
# space變量用兩個空變量做爲標識符,當中是一個空格
space:= $(empty) $(empty)
foo:= a b c
bar:= $(subst $(space),$(comma),$(foo))
# bar is now `a,b,c'.

(4)patsubst 函數

patsubst 函數用於模式匹配的替換,格式以下。

$(patsubst pattern,replacement,text)

下面的例子將文件名"x.c.c bar.c",替換成"x.c.o bar.o"。

$(patsubst %.c,%.o,x.c.c bar.c)

(5)替換後綴名

 替換後綴名函數的寫法是:變量名 + 冒號 + 後綴名替換規則。它實際上patsubst函數的一種簡寫形式。

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

上面代碼的意思是,將變量OUTPUT中的後綴名 .js 所有替換成 .min.js 。

 

4、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

 

其餘Makefile資料

GNU Make 手冊:https://www.gnu.org/software/make/manual/make.html

相關文章
相關標籤/搜索