学习 MakeFile [02] 初探 Makefile

本文主要参考了跟我一起写 Makefile，甚至有一些是直接复制的，原因有三：

因为我有一些自己见解浅薄的

还有一些确实原文章作者写的很好了，但是不写出来又不完整的。

前言

其实我不太知道要咋写 Makefile 这篇文章，感觉可能会变成翻译官方文档

所以…就随心写吧

从一个例子开始

首先我们得知道 Makefile 的规则

target ... : prerequisites ...
    recipe （命令）
    ...
    ...

target
可以是一个object file（目标文件），也可以是一个可执行文件，还可以是一个标签（label）。对于标签这种特性，在后续的“伪目标”章节中会有叙述。
prerequisites
生成该target所依赖的文件和/或target。
recipe
该target要执行的命令（任意的shell命令）。

带着这个规则我们看看个官方的例子：

edit : main.o kbd.o command.o display.o \
        insert.o search.o files.o utils.o
    cc -o edit main.o kbd.o command.o display.o \
        insert.o search.o files.o utils.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 buffer.h
    cc -c display.c
insert.o : insert.c defs.h buffer.h
    cc -c insert.c
search.o : search.c defs.h buffer.h
    cc -c search.c
files.o : files.c defs.h buffer.h command.h
    cc -c files.c
utils.o : utils.c defs.h
    cc -c utils.c
clean :
    rm edit main.o kbd.o command.o display.o \
        insert.o search.o files.o utils.o

注意事项

Makefile 的缩进都需要使用 tab 而不是 space 空格

由于本文章是用 Markdown 写的所以可能会出现缩进使用空格的情况，如需复制请自己更改一下）

这是一个简单的 Makefile

其中第一行：edit 为 target，也就是生成的目标
另外所有的冒号前面的都是 target，只不过由于 edit 在第一行，所以就成为了最终生成的目标
这里 clean 是伪目标，伪目标只是长得像目标，并不应该生成一个叫 clean 的文件，他的目的是执行下一行的命令，就比如 rm ，在命令行输入 make clean 调用它。

关于伪目标

区分目标和伪目标，我们可以写上 .IPHONY : clean ，这样就相当于直接告诉 make clean 并不是需要输出文件的目标

我认为，伪目标是一个很奇怪的规则，他完全可以使用其他的语法，这样设计出一个和目标差不多的东西，会 Makefile 新手感到疑惑，最起码我是这样的
\ 表示换行
target : 后面是依赖
基于上面的规则，我们到该就能明白，makefile 是一个逐步寻找依赖进行编译的文件
比如 edit 依赖于后面的 .o 文件，而下面写了众多 .o 文件依赖于哪些 .c 和 .h 文件，这样在执行 make 命令的时候，就会像调用方法栈一样，一步步找到最开始需要编译的文件，然后出栈，最后调用完输出结果

make 如何工作

在命令行中输入 make 命令，工作流程如下：

make会在当前目录下找名字叫“Makefile”或“makefile”的文件。
如果找到，它会找文件中的第一个目标文件（target），在上面的例子中，他会找到“edit”这个文件，并把这个文件作为最终的目标文件。
如果edit文件不存在，或是 edit 所依赖的后面的 .o 文件的文件修改时间要比 edit 这个文件新，那么，他就会执行后面所定义的命令来生成 edit 这个文件。
如果 edit 所依赖的 .o 文件也不存在，那么 make 会在当前文件中找目标为 .o 文件的依赖性，如果找到则再根据那一个规则生成 .o 文件。
你的 .c 文件和 .h 文件是存在的啦，于是 make 会生成 .o 文件，然后再用 .o 文件生成 make 的终极任务，也就是可执行文件 edit 了。

第 4 步和第 5 步的工作流程就像方法栈一样

使用变量

在上面的例子中，有些地方是大量重复的，此时我们就可以跟写代码一样，使用变量

就比如我们可以设置一个名为 objects 的变量，让他代替所有的 .o 文件

objects = main.o kbd.o command.o display.o \
    insert.o search.o files.o utils.o

edit : ${objects}
    cc -o edit ${objects}

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 buffer.h
    cc -c display.c
insert.o : insert.c defs.h buffer.h
    cc -c insert.c
search.o : search.c defs.h buffer.h
    cc -c search.c
files.o : files.c defs.h buffer.h command.h
    cc -c files.c
utils.o : utils.c defs.h
    cc -c utils.c
clean :
    rm edit ${objects}

这么做的好处

这么做的好处是显而易见的

如果出现其他的 .o 文件，只用改定义处就可以了

make 自动推导

make 是一个智能的工具，它可以自动推导文件以及文件依赖关系后面的命令，于是我们就没必要去在每一个 .o 文件后都写上类似的命令，因为，我们的make会自动识别，并自己推导命令。

所以我们只保留依赖关系即可 Makefile 就可以改成这样

objects = main.o kbd.o command.o display.o \
    insert.o search.o files.o utils.o

edit : $(objects)
    cc -o edit $(objects)

main.o : defs.h
kbd.o : defs.h command.h
command.o : defs.h command.h
display.o : defs.h buffer.h
insert.o : defs.h buffer.h
search.o : defs.h buffer.h
files.o : defs.h buffer.h command.h
utils.o : defs.h

.PHONY : clean
clean :
    rm edit $(objects)

更精简的 Makefile 自动推导文件

Makefile 还提供了自动推导文件的功能，我们要生成 main.o 他会自动识别出来依赖项为 main.c 或者 main.cpp

objects = main.o kbd.o command.o display.o \
    insert.o search.o files.o utils.o

edit : $(objects)
    cc -o edit $(objects)

$(objects) : defs.h
kbd.o command.o files.o : command.h
display.o insert.o search.o files.o : buffer.h

.PHONY : clean
clean :
    rm edit $(objects)

第 7 行 .o 文件对应着 .c 文件，并且所有的 .o 文件都需要依赖于 defs.h
第 8 行 kbd.o command.o files.o 这三个文件除了依赖于名字相同的 .c 文件，大家都依赖的 defs.h 文件，还会依赖 command.h 文件
第 9 行 display.o insert.o search.o files.o 这三个文件除了依赖于名字相同的 .c 文件，大家都依赖的 defs.h 文件，还会依赖 buffer.h 文件

对于这种方式的评价

这种方式里面套的逻辑关系会更多，所以耦合更多，可读性差一些，如果要修改文件结构，则会很麻烦，而且 Makefile 并不是经常需要修改的文件，写的精简但是可读性差有点得不偿失

伪目标（以 clean 为例）

前面简答提到过伪目标，我们这里再总结一下

伪目标是一个为了执行某些命令而写的东西，看着像目标，但实际上并不需要生成任何文件

这种有些迷惑性的规则确实让很多新手小白困惑，因为你可以定义很多你需要的命令，比如你可以定义一个 make ql 的命令，只需要如下定义：

ql :
    rm edit *.o

可以想象，如果 Makefile 变大之后，就很难将 Makefile 里的目标和伪目标区分清楚

所以，我们可以使用 .PHONY 来标明哪些是伪目标，并且将所有的伪目标写到一起。

包含其他 Makefile

在Makefile使用 include 指令可以把别的Makefile包含进来，这很像C语言的 #include ，被包含的文件会原模原样的放在当前文件的包含位置。 include 的语法是：

include <filenames or pathname>...

在 include 前面可以有一些空字符，但是绝不能是 Tab 键开始。 include 和 <filenames> 可以用一个或多个空格隔开。举个例子，你有这样几个 Makefile： a.mk 、 b.mk 、 c.mk ，还有一个文件叫 foo.make ，以及一个变量 $(bar) ，其包含了 bish 和 bash ，那么，下面的语句：

include foo.make *.mk $(bar)

等价于：

include foo.make a.mk b.mk c.mk bish bash

make命令开始时，会找寻 include 所指出的其它 Makefile，并把其内容安置在当前的位置。就好像C/C++的 #include 指令一样。如果文件都没有指定绝对路径或是相对路径的话，make会在当前目录下首先寻找，如果当前目录下没有找到，那么，make还会在下面的几个目录下找：

如果 make 执行时，有 -I 或 --include-dir 参数，那么make就会在这个参数所指定的目录下去寻找。

接下来按顺序寻找目录 <prefix>/include （一般是 /usr/local/bin ）、 /usr/gnu/include 、 /usr/local/include 、 /usr/include 。

环境变量 .INCLUDE_DIRS 包含当前 make 会寻找的目录列表。你应当避免使用命令行参数 -I 来寻找以上这些默认目录，否则会使得 make “忘掉”所有已经设定的包含目录，包括默认目录。

如果有文件没有找到的话，make 会生成一条警告信息，但不会马上出现致命错误。它会继续载入其它的文件，一旦完成 makefile 的读取，make 会再重试这些没有找到，或是不能读取的文件，如果还是不行，make才会出现一条致命信息。如果你想让 make 不理那些无法读取的文件，而继续执行，你可以在 include 前加一个减号 - 。如：

-include <filenames>...

其表示，无论 include 过程中出现什么错误，都不要报错继续执行。如果要和其它版本 make 兼容，可以使用 sinclude 代替 -include 。

环境变量 MAKEFILES

如果你的当前环境中定义了环境变量 MAKEFILES ，那么 make 会把这个变量中的值做一个类似于 include 的动作。这个变量中的值是其它的 Makefile，用空格分隔。

只是，它和 include 不同的是，从这个环境变量中引入的 Makefile 的“默认目标”(the default goal)不会起作用，如果环境变量中定义的文件发现错误，make 也会不理。

但是在这里我还是建议不要使用这个环境变量，因为只要这个变量一被定义，那么当你使用 make 时，所有的 Makefile 都会受到它的影响，这绝不是你想看到的。在这里提这个事，只是为了告诉大家，也许有时候你的 Makefile 出现了怪事，那么你可以看看当前环境中有没有定义这个变量。

make 的工作方式

GNU 的 make工作时的执行步骤如下：（想来其它的 make 也是类似）

读入所有的 Makefile。
读入被 include 的其它 Makefile。
初始化文件中的变量。
推导隐式规则，并分析所有规则。
为所有的目标文件创建依赖关系链。
根据依赖关系，决定哪些目标要重新生成。
执行生成命令。

1-5步为第一个阶段，6-7为第二个阶段。第一个阶段中，如果定义的变量被使用了，那么，make 会把其展开在使用的位置。但 make 并不会完全马上展开，make 使用的是拖延战术，如果变量出现在依赖关系的规则中，那么仅当这条依赖被决定要使用了，变量才会在其内部展开。

当然，这个工作方式你不一定要清楚，但是知道这个方式你也会对 make 更为熟悉。有了这个基础，后续部分也就容易看懂了。

总结

Makefile 里主要包含了五个东西：显式规则、隐式规则、变量定义、指令和注释。

显式规则
显式规则说明了如何生成一个或多个目标文件。这是由 Makefile 的书写者明显指出要生成的文件、文件的依赖文件和生成的命令。
隐式规则
由于我们的 make 有自动推导的功能，所以隐式规则可以让我们比较简略地书写 Makefile ，这是由 make 所支持的。
变量的定义
在 Makefile 中我们要定义一系列的变量，变量一般都是字符串，这个有点像你 C语言中的宏，当 Makefile 被执行时，其中的变量都会被扩展到相应的引用位置上。
指令
其包括了三个部分，一个是在一个 Makefile 中引用另一个 Makefile ，就像C语言中的 include 一样；另一个是指根据某些情况指定 Makefile 中的有效部分，就像 C语言中的预编译 #if 一样；还有就是定义一个多行的命令。有关这一部分的内容，我会在后续的部分中讲述。
注释
Makefile 中只有行注释，和 UNIX 的 Shell 脚本一样，其注释是用 # 字符，这个就像 C/C++ 中的 // 一样。如果你要在你的Makefile中使用 # 字符，可以用反斜杠进行转义，如： \# 。

最后，还值得一提的是，在 Makefile 中的命令，必须要以 Tab 键开始。

Makefile的文件名

默认的情况下，make命令会在当前目录下按顺序寻找文件名为 GNUmakefile 、 makefile 和 Makefile 的文件。在这三个文件名中，最好使用 Makefile 这个文件名，因为这个文件名在排序上靠近其它比较重要的文件，比如 README。最好不要用 GNUmakefile，因为这个文件名只能由GNU make ，其它版本的 make 无法识别，但是基本上来说，大多数的 make 都支持 makefile 和 Makefile 这两种默认文件名。

当然，你可以使用别的文件名来书写Makefile，比如：“Make.Solaris”，“Make.Linux”等，如果要指定特定的Makefile，你可以使用make的 -f 或 --file 参数，如： make -f Make.Solaris 或 make --file Make.Linux 。如果你使用多条 -f 或 --file 参数，你可以指定多个 makefile。