本文参考:
Make 命令教程 - 阮一峰
本学期正在上一门具有“USC神课”之美誉的CSCI402 - Operating Systems。这门课非常的严谨,编程作业的spec写得相当之详细,要求也相当地规范。编程作业要求使用makefile来编译所有的程序,因此该篇文章用于记录我从makefile小白到入门的过程。
1. 什么是Make,什么是Makefile?
In software development, Make is a build automation tool that automatically builds executable programs and libraries from source code by reading files called Makefiles which specify how to derive the target program.
—— wiki
从wiki的解释可以知道,Make是一种自动化的构建工具。那么什么是构建(build)呢?这又先涉及到什么是编译(compile)。编译是指将源代码转换为计算机可执行代码的过程。而关于编译的安排,即先编译哪一部分,后编译哪一部分,则叫做构建(build)。
Make通过读取叫做Makefile的文件,来按照开发者的安排对源代码进行构建。
2. 如何使用make?
make的意思即为“制作”,关于制作一样东西,需要指明的是:
- 要制作什么?
- 它依赖于什么?
- 该怎么通过它的依赖来构建它?
- 当它的依赖有变动时,该怎么处理它们?
比如,在一个名叫rules.txt文件中,有如下规定:
a.txt: b.txt c.txt
cat b.txt c.txt > a.txt
这个文件所要表达的意思是:
- Make需要构建名叫a.txt的文件。
- 它依赖于b.txt与c.txt文件的存在。
- 通过cat命令将b.txt与c.txt合并的方式制作a.txt
需要再命令行执行:
$ make --file=rules.txt
意思是根据rules.txt文件中的规定来构建。
3. 如何编写Makefile
3.1 基本格式
Makefile文件由一系列规则(rules)构成。每条规则的形式如下。
<target> : <prerequisites>
[tab] <commands>
上面第一行冒号前面的部分,叫做"目标"(target),冒号后面的部分叫做"前置条件"(prerequisites);第二行必须由一个tab键起首,后面跟着"命令"(commands)。
"目标"是必需的,不可省略;"前置条件"和"命令"都是可选的,但是两者之中必须至少存在一个。
3.2 目标(target)
一个目标引领一条规则。目标即是需要构建的对象,可以是文件名,如上所示;也可以是某个操作,即伪目标(phony target)。
例如:
clean:
rm *.o
意思为构建一个clean操作,该操作用于移除所有.o文件。
执行的操作是:
make clean
效果是当前目录会生成一个clean操作,并移除所有.o文件。
但是,如果当前目录中,正好有一个文件叫做clean,那么这个命令不会执行。因为Make发现clean文件已经存在,就认为没有必要重新构建了,就不会执行指定的rm命令。
为了避免这种情况,可以明确声明clean是"伪目标",写法如下。
.PHONY: clean
clean:
rm *.o temp
效果是make就不会去检查是否存在一个叫做clean的文件,而是每次运行都执行对应的命令。
如果Make命令运行时没有指定目标,默认会执行Makefile文件的第一个目标。
make
3.3 前置条件(prerequisite)
前置条件通常是一组文件名,之间用空格分隔。它指定了"目标"是否需要重新构建的判断标准:
- 目标不存在,需要构建
- 只要有一个前置文件不存在,或者有过更新(前置文件的last-modification时间戳比目标的时间戳新),"目标"就需要重新构建。
- 其他情况不会重新构建
当某个前置条件中的文件不存在时,需要再写一条规则,来生成所需要的文件。
比如:
result.txt: source.txt
cp source.txt result.txt
source.txt:
echo "this is the source" > source.txt
构建result.txt需要source.txt,但是source.txt可能不存在。如果不存在,或者有过更新,则按照第二条规则来构建出source.txt。
如果执行如下命令:
$ make result.txt
$ make result.txt
第一次执行会先新建 source.txt,然后再新建 result.txt。第二次执行,Make发现 source.txt 没有变动(时间戳晚于 result.txt),就不会执行任何操作,result.txt 也不会重新生成。
如果需要生成多个文件,可以巧妙利用伪目标来实现:
source: file1 file2 file3
在命令行中:
$ make source
3.4 命令(commands)
命令(commands)表示如何构建(更新)目标文件,由一行或多行的Shell命令组成。
每行命令之前必须有一个tab键。需要注意的是,每行命令在一个单独的shell中执行。这些Shell之间没有继承关系。
var-lost:
export foo=bar
echo "foo=[$$foo]"
上面代码执行后make var-lost
,取不到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]"