速览
从Hello World开始,项目有三个头文件defs.h
、buffer.h
、command.h
和八个c文件main.c
、kbd.c
、command.c
、display.c
、insert.c
、search.c
、files.c
、utils.c
这些文件都在同一个目录中,执行下面shell命令创建这些文件
touch defs.h buffer.h command.h main.c kbd.c command.c display.c insert.c search.c files.c utils.c
echo '#include <stdio.h>
#include "defs.h"
int main() {
printf("Hello, World!\n");
return 0;
}
' > main.c
echo -e '#include "defs.h"\n#include "command.h"'> kbd.c
echo -e '#include "defs.h"\n#include "command.h"'> command.c
echo -e '#include "defs.h"\n#include "buffer.h"'> display.c
echo -e '#include "defs.h"\n#include "buffer.h"'> insert.c
echo -e '#include "defs.h"\n#include "buffer.h"'> search.c
echo -e '#include "defs.h"\n#include "buffer.h"\n#include "command.h"'> files.c
echo '#include "defs.h"' > utils.c
从以上创建这些文件的命令中可以看出文件的依赖关系:main.c依赖defs.h;kbd.c和command.c依赖defs.h、command.h;display.c和insert.c以及search.c依赖defs.h、buffer.h;files.c依赖defs.h、buffer.h、command.h;utils.c依赖defs.h
编译Hello World有三个目标:
- 如果这个工程没有编译过,那么我们的所有c文件都要编译并被链接。
- 如果这个工程的某几个c文件被修改,那么我们只编译被修改的c文件,并链接目标程序。
- 如果这个工程的头文件被改变了,那么我们需要编译引用了这几个头文件的c文件,并链接目标程序。
为完成这三个目标,Makefile的内容如下:
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
执行make
命令查看结果:
执行make clean
清除编译后的文件
Makefile的规则模式
Makefile内容由一组模式规则组成的规则集合,每条Makefile的规则模式为:
target ... : prerequisites ...
recipe
...
...
- target 是要成生的目标文件(main.o、kbd.o、edit),或是一个标签(clean)后面会介绍这个”标签”,暂时忽略它。括号中为HelloWorld示例中内容
- prerequisites 生成该target所依赖的文件或其他target
- recipe 该target要执行的命令(任意的shell命令)
一个或多个target目标文件依赖于prerequisites中的文件,prerequisites中如果有文件比target文件要新的话,recipe就会执行生成target,这是Makefile处理逻辑的核心
以HelloWorld示例中代码片段来解释一下规则模式:
main.o : main.c defs.h
cc -c main.c
......
clean :
rm edit main.o kbd.o command.o display.o insert.o search.o files.o utils.o
这里main.o
是target目标文件,main.c和defs.h是prerequisites(依赖文件),cc -c main.c
是recipe,recipe单独一行时候必须以Tab
键开头,当执行make
命令时,当target(目标文件)不存在,或者prerequisites(依赖文件)比target(目标文件)的日期要新,就会执行这个规则模式的recipe
这里的clean
是一个target标签(官方称其为伪目标),这个target没有依赖文件;伪目标需手动执行,此处为:
make clean
这条规则会清除之前生成的.o
文件和edit
,通过执行make clean
可以重新整体构建整个项目
make 处理流程
默认方式下(只输入 make
命令):
- make在当前目录下找名为“Makefile”或“makefile”的文件
- 如果找到,把“Makefile”或“makefile”文件中的第一个目标文件(target)作为最终的目标文件,HelloWorld示例中,“edit”就是最终目标文件
- 若edit文件不存在,或者edit所依赖的
.o
文件的文件修改时间要比edit
新,会执行这条规则模式中的recipe生成edit
这个文件 - 若
edit
所依赖的.o
文件也不存在,make会在“Makefile”或“makefile”文件中找目标为.o
文件的规则模式,然后执行这些规则模式,以此递归方式执行下去。 - 每个
.o
依赖文件(对应.c
和.h
)都是存在的,make会生成.o
文件,然后再用.o
文件生 成make的最终目标文件edit
make会一层层寻找文件的依赖关系,若所有的依赖关系都满足,则可以执行每个规则模式的recipe;若依赖关系不满足make会报错退出。
若HelloWorld项目被编译过了并且没有执行make clean
,若只修改file.c
,再次执行make
时,根据处理流程file.o
会被覆盖,然后edit
也会重新生成
Makefile 变量
HelloWorld中,在edit规则和clean规则main.o kbd.o command.o display.o insert.o search.o files.o utils.o
被重复书写了3次
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
clean :
rm edit main.o kbd.o command.o display.o insert.o search.o files.o utils.o
通过定义objects变量,并且以$(objects)
方式使用变量,来简化Makefile
#定义objects变量
objects = main.o kbd.o command.o display.o insert.o search.o files.o utils.o
#使用objects变量
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)
make 自动推导
GNU的make可以自动推导文件依赖关系(prerequisites)和命令(recipe),make看到一个 .o
文件,会自动把对应 .c
文件加在依赖关系中;
例如:make找到一个whatever.o
目标文件(target) ,会把 whatever.c
作为 whatever.o
的依赖文件。并且
cc -c whatever.c
作为recipe也被推导出来,于是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)
这里使用.PHONY
显示的指明clean
是一个伪目标,这种书写规则方式叫做隐式规则
Makefile 另一种风格
不推荐使用此种风格的Makefile
利用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)
$(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)
defs.h
是所有目标文件的依赖文件, command.h
和 buffer.h
分别是kbd.o command.o files.o
和display.o insert.o search.o files.o
的依赖文件。
此风格可以进一步简化Makefile,但文件依赖关系显得模糊凌乱,因此不推荐使用此种风格的Makefile
清除目标文件
为了能够让项目重新整体构建,Makefile中应该有个清除目标文件的规则:
clean :
rm edit $(objects)
# 更稳健的方式
.PHONY : clean
-rm edit $(objects)
.PHONY
表示 clean
是一个“伪目标”。rm
命令前面-
表示忽略此recipe执行错误,继续执行。
通过make clean
和make clean2
执行以下规则,可观察-
的使用效果:
.PHONY : clean
rm edit $(objects)
echo "jartap.com"
.PHONY : clean2
-rm edit $(objects)
echo "jartap.com"
Makefile 内容组成
Makefile里主要包含:显式规则、隐式规则、变量定义、指令和注释。
- 显式规则:显式说明如何生成一个或多个目标文件。这是由Makefile的书写者明显指出要生成的文件、文件的依赖文件和生成的命令
- 隐式规则:因make有自动推导功能,所以隐式规则可以简化书写Makefile
- 变量的定义:Makefile中定义的一系列变量,变量一般都是字符串,当Makefile被执行时,其中的变量会被扩展到相应的使用位置上
- 指令:其包括了三个部分,个是在一个Makefile中引用另一个Makefile,就像C语言中 的include一样;另一个是指根据某些情况指定Makefile中的有效部分,就像C语言中的预编译#if一 样;还有就是定义一个多行的命令。有关这一部分的内容,我会在后续的部分中讲述。
- 注释:Makefile中只有行注释,用
#
字符注释整行;若要在Makefile中使用#字符,可以用反斜杠转义\#
make 规则文件名
默认的情况下,make命令会在当前目录下按顺序寻找文件名为 GNUmakefile
、 makefile
和Makefile
的文件。
推荐使用Makefile
,因为Makefile
在排序上靠近比较重要的文件,比如 README
。
最好不要用 GNUmakefile
,因为这个文件名只能由GNU make
,其它版本的 make
无法识别
但是基本上来说,大多数的 make
都支持makefile
和 Makefile
这两种默认文件名。
同时可以使用-f
或--file
参数指定make
使用的规则文件名,例如make -f Jartap.Makefile
指定了规则文件名为Jartap.Makefile
,
make -f Jartap.Makefile -f Red.Makefile
指定了两个规则文件
包含其它Makefile
Makefile使用include
指令把别的Makefile包含进来,被包含的文件会原模原样的放在当前文件的包含位置。 include
的语法:
include <filenames>...
<filenames>
是当前操作系统Shell的文件模式(可以包含路径和通配符),在 include
前面可以有一些空字符,但不能以 Tab
键开始
示例:
bar = bish bash
include foo.make *.mk $(bar)
# 当前目录下有a.mk b.mk c.mk三个以mk结尾的文件,上述include等价于
include foo.make a.mk b.mk c.mk bish bash
make命令寻找 include
所指出的其它Makefile,并把其内容安置在当前的位置。若文件没有指定路径,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
“忘掉”所有已经设定的包含目录,包括默认
目录
filename不存在,make则生成一条警告信息,但不会马上出现致命错误,会继续载入其它的文件,一旦完成makefile的读取,
make会再重试这些没有找到,或是不能读取的文件,如果还是不行,make才会出现一条致命信息。 让make忽略那些无法读取的文件,继续执行,可以在include前加一个减号-
:
-include <filenames>...
其表示,无论include过程中出现什么错误,都不要报错继续执行。如果要和其它版本 make
兼容,
可以使用 sinclude
代替 -include
MAKEFILES环境变量
若当前环境中定义了环境变量 MAKEFILES
,那么make会把这个变量中的值做一个类似于
include
的动作。这个变量中的值是其它的Makefile,用空格分隔。只是,它和 include
不
同的是,从这个环境变量中引入的Makefile的“目标”不会起作用,如果环境变量中定义的文件发现
错误,make也会不理。
但是在这里我还是建议不要使用这个环境变量,因为只要这个变量一被定义,那么当你使用make时, 所有的Makefile都会受到它的影响,这绝不是你想看到的。在这里提这个事,只是为了告诉大家,也许 有时候你的Makefile出现了怪事,那么你可以看看当前环境中有没有定义这个变量。
make 工作方式
GNU的make工作时的执行步骤如下:
- 读入所有的Makefile
- 读入被include的其它Makefile
- 初始化文件中的变量
- 推导隐式规则,并分析所有规则
- 为所有的目标文件创建依赖关系链
- 根据依赖关系,决定哪些目标要重新生成
- 执行生成命令
准备阶段:1-5步骤 执行阶段:6、7两步 1-5步为第一个阶段6-7为第二个阶段。第一个阶段中,如果定义的变量被使用了,那么,make会把其展 开在使用的位置。但make并不会完全马上展开,make使用的是拖延战术,如果变量出现在依赖关系的规则 中,那么仅当这条依赖被决定要使用了,变量才会在其内部展开。