本文基于博主陈皓文章读后所做的笔记,欢迎跳至原文链接:https://blog.csdn.net/haoel/article/details/2886
这里的Makefile是基于Linux下GNU的make。
Makefile学习笔记(一)
1、Makefile规则
Makefile的规则或者说架构大致可以写成下面这样:
target … : prerequisites …
command
…
…
其中target后面接的是目标文件,可以是Object文件也可以是执行文件。还可以是一个标签类的(Label)。
prerequisites是要生成那个target所需要的file或是目标。
command也就是make需要执行的命令(任意shell命令即可)。
这三个命令构成了一种文件的依赖关系,总的来说:你的target(其中一个或者多个目标文件)是取决于prerequisites中的文件的,这个文件的生成规则由command来定义。极端假设来说:只要prerequisites中有一个或以上的文件比你现有的target文件版本新的话,command命令就会执行。
2、Makefile的一个例子
现有一个工程,这个工程中有3个头文件和8个C文件,我们按照前面的那三个规则来做的话,应该是下面这样:
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”这种的文件中,在该目录下直接输入命令“make”即可生成执行文件edit。删除所有内容的命令是“make clean”(包括执行文件和中间目标文件)。
在这个makefile中,目标文件(target)包含:执行文件(edit)和中间目标文件(*.o),先决条件文件(prerequisites)就是“:”后的那些.c、.h文件。每一个.o文件都有一组prerequisites文件,而.o文件又是edit文件的prerequisites文件。这三种类型的文件构成了一个类似于三角形的关系,可以根据这个关系找到目标文件是由哪些文件生成的,
定义好文件之间的关系之后,后面的那一行“cc -c main.c”类似这样的定义了如何生成目标文件的操作系统命令,一定要以一个Tab键作为开头。记住,make并不管命令是怎么工作的,他只管执行所定义的命令。make会比较targets文件和prerequisites文件的修改日期,如果prerequisites文件的日期要比targets文件的日期要新,或者target不存在的话,那么,make就会执行后续定义的命令。(至于原因的话,应该不太重要吧……)
之前不是有个make clean嘛,这个clean不是一个文件,它只不过是一个动作名字,有点像C语言中的lable一样,其冒号后什么也没有,那么,make就不会自动去找文件相关的prerequisites文件,也就不会自动执行其后所定义的命令。要执行其后的命令,就要在make命令后明显得指出这个lable的名字。这样的方法非常有用,我们可以在一个makefile中定义不用的编译或是和编译无关的命令,比如程序的打包,程序的备份,等等。
3、Makefile是如何工作的
在默认的方式下,也就是我们只输入make命令。那么,
1、make会在当前目录下找名字叫“Makefile”或“makefile”的文件。
2、如果找到,它会找文件中的第一个目标文件(target),在上面的例子中,他会找到“edit”这个文件,并把这个文件作为最终的目标文件。
3、如果edit文件不存在,或是edit所依赖的后面的 .o 文件的文件修改时间要比edit这个文件新,那么,他就会执行后面所定义的命令来生成edit这个文件。
4、如果edit所依赖的.o文件也存在,那么make会在当前文件中找目标为.o文件的依赖性,如果找到则再根据那一个规则生成.o文件。(这有点像一个堆栈的过程)
5、当然,你的C文件和H文件是存在的啦,于是make会生成 .o 文件,然后再用 .o 文件声明make的终极任务,也就是执行文件edit了。
(依赖也就是前面的prerequisites)
这就是整个make的依赖性,make会一层又一层地去找文件的依赖关系,直到最终编译出第一个目标文件。在找寻的过程中,如果出现错误,比如最后被依赖的文件找不到,那么make就会直接退出,并报错,而对于所定义的命令的错误,或是编译不成功,make根本不理。make只管文件的依赖性,即:如果在我找了依赖关系之后,冒号后面的文件还是不在,那么对不起,我就罢工啦。
通过上述分析,我们知道,像clean这种,没有被第一个目标文件直接或间接关联,那么它后面所定义的命令将不会被自动执行,不过,我们可以显示要make执行。即命令——“make clean”,以此来清除所有的目标文件,以便重编译。
于是在我们编程中,如果这个工程已被编译过了,当我们修改了其中一个源文件,比如file.c,那么根据我们的依赖性,我们的目标file.o会被重编译(也就是在这个依性关系后面所定义的命令),于是file.o的文件也是最新的啦,于是file.o的文件修改时间要比edit要新,所以edit也会被重新链接了(详见edit目标文件后定义的命令)。
而如果我们改变了“command.h”,那么,kdb.o、command.o和files.o都会被重编译,并且,edit会被重链接。
4、Makefile中使用变量
edit的规则:
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
易知:[.o]文件都重复了两次,如果我们要加入一个新的[.o]文件,我们也要加两次才行(clean中其实也要加一次,但是我现在还不知道怎么加)。如果很简单的话,这并不难,如果工程很复杂的话,就需要用到变量了,这个变量类似于C语言中的宏。
比如,声明一个变量:objects或者OBJ之类的来表示obj文件,在makefile一开始就定义:
objects = main.o kbd.o command.o display.o /
insert.o search.o files.o utils.o
这样之后,我们可以在makefile中以“$(objects)”的方式来使用这个变量了,这样之后我们可以将之前的代码更改为有变量的代码了:
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)
对于变量的操作跟C语言中的宏定义一样。
5、让Make自动推导
GNU的make十分强大,它能自动推导文件以及文件依赖关系后面的命令,于是我们就没必要去在每一个[.o]文件后都写上类似的命令,因为make会自动识别,并自己推导命令。
只要make看到一个[.o]文件,它就会自动的把[.c]文件加在依赖关系中,如果make找到一个whatever.o,那么whatever.c,就会是whatever.o的依赖文件。并且 cc -c whatever.c 也会被推导出来,于是,我们的makefile再也不用写得这么复杂。我们又有一版新的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是个伪目标文件。(后面要学一下关于“伪目标文件”和“隐晦规则”)
6、另一种风格的makefile
既然make自己有一定的“智能”,那么上面的命令还能够改进:
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)
这个是基于[.o]文件改进的,可以将上一版的makefile看成由A→B,这一版就是由B→A。
7、清空目标文件的规则
每一个Makefile中都应该写一个清空目标文件(.o和执行文件)的规则,这是一个良好习惯。一般风格是:
clean :
rm edit $(objects)
更好的做法是:
.PHONY : clean
clean :
-rm edit $(objects)
.PHONY意思表示clean是一个“伪目标”,。而在rm命令前面加了一个小减号的意思就是,也许某些文件出现问题,但不要管,继续做后面的事。当然,clean的规则不要放在文件的开头,不然,这就会变成make的默认目标,相信谁也不愿意这样。不成文的规矩是——“clean从来都是放在文件的最后”。