Makefile文件说明 [1]

Makefile文件的格式:

// Makefile文件由一系列规则(rules)构成。每条规则的形式如下
<target> : <prerequisites>
[tab]  <commands>

上面第一行冒号前面的部分,叫做"目标"(target),冒号后面的部分叫做"前置条件"(prerequisites);
第二行必须由一个tab键起首,后面跟着"命令"(commands)。

目标(target)

一个目标(target)就构成一条规则
目标可以是一个文件名,也可以是多个文件名,之间用空格分隔

除了文件名,目标还可以是某个操作的名字,这称为”伪目标”(phony target):

clean:
  rm *.o
// 上面代码的目标是clean,它不是文件名,而是一个操作的名字,属于"伪目标 "

如果当前目录中,正好有一个文件叫做clean,那么这个命令不会执行:

因为Make发现clean文件已经存在,就认为没有必要重新构建了,就不会执行指定的rm命令
为了避免这种情况,可以明确声明clean是"伪目标",写法如下:
.PHONY: clean
clean:
        rm *.o temp
声明clean是"伪目标"之后,make就不会去检查是否存在一个叫做clean的文件,而是每次运行都执行对应的命令

像.PHONY这样的内置目标名还有不少,可以查看手册 [2]

前置条件(prerequisites)

前置条件通常是一组文件名,之间用空格分隔:

它指定了"目标"是否重新构建的判断标准:
1. 只要有一个前置文件不存在
2. 有过更新(前置文件的last-modification时间戳比目标的时间戳新),"目标"就需要重新构建

实例:

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

连续执行两次make result.txt:

第一次执行会先新建 source.txt,然后再新建 result.txt
第二次执行,Make发现 source.txt 没有变动(时间戳晚于 result.txt),
  就不会执行任何操作,result.txt 也不会重新生成

命令(commands)

命令(commands)表示如何更新目标文件,由一行或多行的Shell命令组成:

它是构建"目标"的具体指令,它的运行结果通常就是生成目标文件

每行命令之前必须有一个tab键。如果想用其他键,可以用内置变量.RECIPEPREFIX声明:

.RECIPEPREFIX = >
all:
> echo Hello, world
// 用.RECIPEPREFIX指定,大于号(>)替代tab键
// 所以,每一行命令的起首变成了大于号,而不是tab键

注意:每行命令在一个单独的shell中执行。这些Shell之间没有继承关系:

// 有问题
var-lost:
    export foo=bar
    echo "foo=[$$foo]"

// 正确1
var-kept:
    export foo=bar; echo "foo=[$$foo]"

// 正确2
var-kept:
    export foo=bar; \
    echo "foo=[$$foo]"

// 正确3(是加上.ONESHELL:命令)
.ONESHELL:
var-kept:
    export foo=bar;
    echo "foo=[$$foo]"

Makefile文件的语法

注释(井号(#)在Makefile中表示注释):

# 这是注释
result.txt: source.txt
    # 这是注释
    cp source.txt result.txt # 这也是注释

回声(echoing):

正常情况下,make会打印每条命令,然后再执行,这就叫做回声(echoing)
test:
    # 这是测试
执行上面的规则,会得到下面的结果:
$ make test
# 这是测试

在命令的前面加上@,就可以关闭回声:
test:
    @# 这是测试

// 通常只在注释和纯显示的echo命令前面加上@
test:
    @# 这是测试
    @echo TODO

通配符:

Makefile 的通配符与 Bash 一致,主要有星号(*)、问号(?)和 [...]
如:
clean:
    rm -f *.o

模式匹配:

%.o: %.c

等同于下面的写法:
f1.o: f1.c
f2.o: f2.c
// 使用匹配符%,可以将大量同类型的文件,只用一条规则就完成构建

变量和赋值符 [3]

1. Makefile 允许使用等号自定义变量(变量需要放在 $( ) 之中):
txt = Hello World
test:
    @echo $(txt)

2. 调用Shell变量,需要在美元符号前,再加一个美元符号,这是因为Make命令会对美元符号转义:
test:
  @echo $$HOME

3. Makefile一共提供了四个赋值运算符 (=、:=、?=、+=)
VARIABLE = value
# 在执行时扩展,允许递归扩展。

VARIABLE := value
# 在定义时扩展。

VARIABLE ?= value
# 只有在该变量为空时才设置值。

VARIABLE += value
# 将值追加到变量的尾端。

内置变量(Implicit Variables) [4]

Make命令提供一系列内置变量,比如:
$(CC) 指向当前使用的编译器,$(MAKE) 指向当前使用的Make工具
这主要是为了跨平台的兼容性,详细的内置变量清单见手册
output:
    $(CC) -o output input.c

自动变量(Automatic Variables) [5]

(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 $< $@

判断和循环:

// 实例1
Makefile使用 Bash 语法,完成判断和循环:

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

// 实例2
LIST = one two three
all:
    for i in $(LIST); do \
        echo $$i; \
    done

# 等同于

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

函数 [6]

Makefile 还可以使用函数,格式如下:
$(function arguments)
# 或者
${function arguments}

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

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

(3)subst 函数
$(subst from,to,text)

实例1(将字符串"feet on the street"替换成"fEEt on the strEEt"):
$(subst ee,EE,feet on the street)

实例2:
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 。

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
[1]http://www.ruanyifeng.com/blog/2015/02/make.html
[2]https://www.gnu.org/software/make/manual/html_node/Special-Targets.html#Special-Targets
[3]https://stackoverflow.com/questions/448910/what-is-the-difference-between-the-gnu-makefile-variable-assignments-a
[4]https://www.gnu.org/software/make/manual/html_node/Implicit-Variables.html
[5]https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html
[6]https://www.gnu.org/software/make/manual/html_node/Functions.html