编程宝库 - 技术改变世界

编程宝库

Makefile

Makefile 编写规则

Makefile 是一个纯文本文件，它包含了构建目标文件的一系列规则（rules）, 这些规则最终由 make 命令解释执行。

Makefile 文件由一系列规则（rules）构成。每条规则的形式如下：

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

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

"目标"是必需的，不可省略；"前置条件"和"命令"都是可选的，但是两者之中必须至少存在一个。

每条规则就明确两件事：构建目标的前置条件是什么，以及如何构建。下面就详细讲解，每条规则的这三个组成部分。

以下范例是一个比较简单的 Makefile，工程最终编译成可执行文件 edit。

edit : main.o kbd.o

main.o : main.c defs.h
	cc -c main.c
	
kbd.o : kbd.c defs.h command.h
	cc -c kbd.c

clean :
	rm edit main.o kbd.o

一个目标（target）就构成一条规则。目标通常是文件名，指明 make 命令所要构建的对象，比如范例中的 edit。目标可以是一个文件名，也可以是多个文件名，之间用空格分隔。

除了文件名，目标还可以是某个操作的名字，这称为"伪目标"（phony target）。

clean:
	rm edit main.o kbd.o

上面代码的目标是 clean，它不是文件名，而是一个操作的名字，属于"伪目标"，作用是删除对象文件。

$ make clean

但是，如果当前目录中，正好有一个文件叫做 clean，那么这个命令不会执行。因为 make发现 clean 文件已经存在，就认为没有必要重新构建了，就不会执行指定的rm命令。

为了避免这种情况，可以明确声明 clean 是"伪目标"，写法如下：

.PHONY: clean
clean:
	rm edit main.o kbd.o

声明clean是 "伪目标" 之后，make 就不会去检查是否存在一个叫做 clean 的文件，而是每次运行都执行对应的命令。像.PHONY 这样的内置目标名还有不少，可以查看手册。

如果 make 命令运行时没有指定目标，默认会执行 Makefile 文件的第一个目标。

$ make

上面代码执行 Makefile 文件的第一个目标。

前置条件通常是一组文件名，之间用空格分隔。它指定了 "目标" 是否重新构建的判断标准：只要有一个前置文件不存在，或者有过更新（前置文件的 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 后面没有前置条件，就意味着它跟其他文件都无关，只要这个文件还不存在，每次调用 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

命令（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 是一个包含编译和链接规则的纯文本文件，它有自己特定的语法。包括：注释、回声（echoing）、通配符、模式匹配、变量和赋值符、内置变量（Implicit Variables）、自动变量（Automatic Variables）、判断和循环以及函数。