0%

Makefile教程

一份简单的Makefile介绍入门,帮助在Linux系统下编译C/C++。

引出

如果有一个test.cpp文件,在命令行里输入

1
g++ test.cpp -o test

即可对cpp文件进行编译,生成test可执行文件。

如此,每次对cpp文件进行修改后,都要重新输入该命令进行编译,过程复杂且重复。

所以,可以将这些命令打包成makefile文件,定义了一系列的规则来指定哪些文件需要先编译,哪些文件需要后编译,哪些文件需要重新编译,甚至于进行更复杂的功能操作。

在该文件夹下生成一个空文件,命名为Makefliemakefile

makefile
1
2
test: test.cpp
g++ test.cpp -o test

第二行的开头为Tab键,如为空格键则会出现makefile:2: *** missing separator. Stop.的报错。

VSCode中默认Tab键转化为空格,如需输入Tab键,关闭设置中Editor: Insert Spaces选项。

在命令行中输入

1
make

即可对test.cpp文件进行编译,效果与gcc test.cpp -o test相同。

Makefile的规则

Makefile的基础框架

1
2
target: prerequisites
command
  • target(目标):可以是一个object file(目标文件),也可以是一个执行文件,还可以是一个标签(label)
  • prerequisites(依赖):生成该target所依赖的文件和target
  • command(命令):该target要执行的命令(任意的shell命令)

target这一个或多个的目标文件依赖于prerequisites中的文件,其生成规则定义在command中。

一个示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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中使用变量

在makefile中使用变量类似于C/C++中的宏。

定义一个变量objects

1
objects = main.o kbd.o command.o display.o

则可以在makefile中以$(objects)的方式来使用这个变量。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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)

隐晦规则

make可以自动识别和推倒指令。只要make看到一个 .o 文件,它就会自动的把 .c 文件加在依赖关系中,如果make找到一个whatever.o ,那么 whatever.c 就会是 whatever.o 的依赖文件, cc -c whatever.c 就会被推导出来。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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是个伪目标文件。

由于很多.o文件都依赖相同的.h文件,在此之上,可以进一步简化。

1
2
3
4
5
6
7
8
9
10
11
12
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)

清空目标文件的规则

每个Makefile中都应该写一个清空目标文件(.o和执行文件)的规则,这不仅便于重编译,也很利于保持文件的清洁。

1
2
clean :
rm edit $(objects)

更为稳健的做法是:

1
2
3
.PHONY : clean
clean :
-rm edit $(objects)

.PHONY 表示clean是一个“伪目标”。

rm命令前面加了一个小减号的意思就是,也许某些文件出现问题,但不要管,继续做后面的事。

Makefile的运行

输入make命令后,

  1. 在当前目录下找名字叫“Makefile”或“makefile”的文件;
  2. 找文件中的第一个目标文件(target),并把这个文件作为最终的目标文件;
  3. 如果最终的目标文件不存在,或是最终的目标文件所依赖的后面的 .o 文件的文件修改时间要比最终的目标文件新,则执行后面所定义的命令来生成最终的目标文件;
  4. 如果最终的目标文件所依赖的 .o 文件也不存在,那么make会在当前文件中找目标为 .o 文件的依赖性,如果找到则再根据那一个规则生成 .o 文件;
  5. make会生成 .o 文件,然后再用 .o 文件生成make的最终的目标文件。

如果target与第一个目标文件没有任何关联(如clean),则该命令不会执行。如要执行clean,则需另外输入make clean命令。

参考

  1. Makefile的写法(b站视频教程)
  2. 跟我一起写Makefile