分类: C/C++
2015-03-16 14:46:16
原文地址:makefile(1) 作者:linux_wuliqiang
本部分将用一个示例来说明如何建立一个makefile文件,以便给大家一个感性认识。这个示例来源于GNU的make使用手册,工程中有8个C文件和3个头文件,要写一个makefile文件来告诉make命令如何编译和连接这几个文件。makefile文件的操作规则是:
● 如果这个工程没有编译过,所有C文件都要编译并被连接。
● 如果这个工程的某几个C文件被修改,只需编译被修改的C文件,并连接目标程序。
● 如果这个工程的头文件被改变了,需要编译引用了这几个头文件的C文件,并连接目标程序。
只要makefile文件写得足够好,所有的这一切,只用一个make命令就可以完成,make命令会自动智能地根据当前文件的修改情况来确定哪些文件需要重新编译,从而自动编译所需要的文件并连接目标程序。
在讲述这个makefile文件之前,还是先来粗略地看一看下面的代码:
target ... : prerequisites ...
command
...
...
上面的代码中,target是一个目标文件,可以是Object 文件,也可以是执行文件,还可以是一个标签(Label)。对于标签的特性,在5.3.5节中讲解。
prerequisites是要生成的target所需要的文件或是目标。
command是make需要执行的命令(任意的Shell命令)。
这是一个文件的依赖关系,target这一个或多个的目标文件依赖于prerequisites中的文件,其生成规则定义在command中。prerequisites中如果有一个以上的文件比target文件更新的话,command所定义的命令就会执行。这就是makefile文件的规则,也就是makefile文件中最核心的内容。下面结合实例作详细说明。
下面通过一个实例来讲述make与makefile文件的关系。
实例5-1是一个完整的makefile文件,在一个工程中有3个头文件和8个C文件,其中应用到了前面讲述的3个规则。
实例5-1
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
gcc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
main.o : main.c defs.h
gcc -c main.c
kbd.o : kbd.c defs.h command.h
gcc -c kbd.c
command.o : command.c defs.h command.h
gcc -c command.c
display.o : display.c defs.h buffer.h
gcc -c display.c
insert.o : insert.c defs.h buffer.h
gcc -c insert.c
search.o : search.c defs.h buffer.h
gcc -c search.c
files.o : files.c defs.h buffer.h command.h
gcc -c files.c
utils.o : utils.c defs.h
gcc -c utils.c
clean :
rm edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
提示:
反斜杠“\”是换行符的意思。这样使makefile文件更易读。可以把这个内容保存在“makefile文件”或“makefile文件夹”的文件中,然后在该目录下直接输入命令make,就可以生成执行文件edit。如果要删除执行文件和所有的中间目标文件,只要简单地执行一下make clean就可以了。
在这个makefile文件中,目标文件(target)包含如下内容:执行文件edit和中间目标文件(*.o);依赖文件(prerequisites),即冒号后面的那些 .c 文件和 .h文件。每一个 .o 文件都有一组依赖文件,而这些 .o 文件又是执行文件edit的依赖文件。依赖关系的实质是说明目标文件由哪些文件生成,换言之,目标文件是哪些文件更新的结果。在定义好依赖关系后,后续的代码定义了如何生成目标文件的操作系统命令,其一定要以一个Tab键作为开头。
提示:
make并不管命令是怎么工作的,它只管执行所定义的命令。make会比较targets文件和prerequisites文件的修改日期,如果prerequisites文件的日期比targets文件的日期要新,或者target不存在,make就会执行后续定义的命令。另外,clean不是一个文件,它只不过是一个动作名字,有点像C语言中的lable一样,冒号后什么也没有,这样make就不会自动去找文件的依赖性,也就不会自动执行其后所定义的命令。要执行其后的命令,就要在make命令后明显地指出这个lable的名字。这样的方法非常有用,可以在一个makefile文件中定义不用的编译或是和编译无关的命令,比如程序的打包或备份等。
在默认方式下,只输入make命令。其会做如下工作:
make会在当前目录下找名字为“makefile文件”或“makefile文件夹”的文件。如果找到,它会找文件中的第一个目标文件(target)。在上面的例子中,它会找到edit这个文件,并把这个文件作为最终的目标文件;如果edit文件不存在,或是edit所依赖的后面的 .o 文件的修改时间要比edit这个文件新,它就会执行后面所定义的命令来生成edit文件。
如果edit所依赖的.o文件也存在,make会在当前文件中找目标为.o文件的依赖性,如果找到,则会根据规则生成.o文件(这有点像一个堆栈的过程)。
当然,C文件和H文件如果存在,make会生成 .o 文件,然后再用 .o 文件生成make的最终结果,也就是执行文件edit。
这就是整个make的依赖性,make会一层又一层地去找文件的依赖关系,直到最终编译出第一个目标文件。在找寻的过程中,如果出现错误,比如最后被依赖的文件找不到,make就会直接退出,并报错。而对于所定义的命令的错误,或是编译不成功,make就不会处理。如果在make找到了依赖关系之后,冒号后面的文件不存在,make仍不工作。
通过上述分析,可以看出像clean这样没有被第一个目标文件直接或间接关联时,它后面所定义的命令将不会被自动执行,不过,可以显式使make执行。即使用命令make clean,以此来清除所有的目标文件,并重新编译。
在编程中,如果这个工程已被编译过了,当修改了其中一个源文件时,比如file.c,根据依赖性,目标file.o会被重新编译(也就是在这个依赖性关系后面所定义的命令),则file.o文件也是最新的,即file.o文件的修改时间要比edit要新,所以edit也会被重新连接了。而如果改变了command.h,kdb.o、command.o和files.o都会被重新编译,并且edit会被重新连接。
在上面的例子中,先通过实例5-2来看看edit的规则。
实例5-2
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
gcc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
可以看到,[.o]文件的字符串被重复了两次。如果这个工程需要加入一个新的[.o]文件,需要在两个位置插入(实际是3个位置,还有一个位置在clean中)。当然,这个makefile文件并不复杂,所以在两个位置加就可以了。但如果makefile文件变得复杂,就要在第3个位置插入,该位置容易被忘掉,从而会导致编译失败。所以,为了makefile文件的易维护,在makefile文件中可以使用变量。makefile文件的变量也就是一个字符串,可以理解成C语言中的宏。比如,声明一个变量objects,在makefile文件一开始可以这样定义,见实例5-3:
实例5-3
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
于是,就可以很方便地在makefile文件中以$(objects)的方式来使用这个变量了。改良版的makefile文件就变成实例5-4的样子:
实例5-4
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
gcc -o edit $(objects)
main.o : main.c defs.h
gcc -c main.c
kbd.o : kbd.c defs.h command.h
gcc -c kbd.c
command.o : command.c defs.h command.h
gcc -c command.c
display.o : display.c defs.h buffer.h
gcc -c display.c
insert.o : insert.c defs.h buffer.h
gcc -c insert.c
search.o : search.c defs.h buffer.h
gcc -c search.c
files.o : files.c defs.h buffer.h command.h
gcc -c files.c
utils.o : utils.c defs.h
gcc -c utils.c
clean :
rm edit $(objects)
如果有新的.o文件加入,只需简单地修改一下objects变量就可以了。
GNU的make功能很强大,它可以自动推导文件以及文件依赖关系后面的命令,此时就没有必要在每一个[.o]文件后都写上类似的命令,因为make会自动识别,并自己推导命令。
只要make看到一个.o文件,它就会自动把[.c]文件加在依赖关系中;如果make找到whatever.o,则whatever.c就会成为whatever.o的依赖文件。并且 gcc -c whatever.c 也会被推导出来,于是,makefile文件再也不用写得太复杂,可以简化为实例5-5。
实例5-5
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
gcc -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)
这种方法也就是make的“隐晦规则”。上面的文件内容中,.PHONY表示clean是个伪目标文件。
即然make可以自动推导命令,则可以将过多的[.o]和[.h]进行简化,删除重复的[.h],结果如实例5-6。
实例5-6
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
gcc -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文件,那就更不清楚了。
每个makefile文件中都应该写一个清空目标文件(.o和执行文件)的规则,这不仅便于重新编译,也很利于保持文件的清洁。一般的风格如下:
实例5-7
clean:
rm edit $(objects)
更为稳健的做法是:
实例5-8
.PHONY : clean
clean :
-rm edit $(objects)
前面说过,.PHONY表示clean是一个“伪目标”,而在rm命令前面加了一个小减号的目的是,如果某些文件出现问题将被忽略,继续进行后面的操作。当然,clean的规则不要放在文件的开头,否则会变成make的默认目标。不成文的规矩是“clean从来都放在文件的最后”。
上面讲述的实例是一个makefile文件的概貌,也是编写一般makefile文件的基础。