跟我一起写 Makefile
2020-02-27 210浏览
- 1.跟我一起写 Makefile 作者:陈皓 跟我一起写 Makefile 作者:陈皓 整理:祝冬华 第 1 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 2.跟我一起写 Makefile 作者:陈皓 第一部分、概述...............................................................................................................................6 第二部分、关于程序的编译和链接...............................................................................................6 第三部分、Makefile 介绍 ............................................................................................................7 一、Makefile的规则 ..............................................................................................................7 二、一个示例...........................................................................................................................8 三、make是如何工作的........................................................................................................9 四、makefile中使用变量....................................................................................................10 五、让make自动推导..........................................................................................................11 六、另类风格的makefile....................................................................................................12 七、清空目标文件的规则.....................................................................................................13 第四部分、Makefile 总述 ..........................................................................................................13 一、Makefile里有什么? ....................................................................................................13 1、显式规则。 ..............................................................................................................14 2、隐晦规则。 ..............................................................................................................14 3、变量的定义。 ..........................................................................................................14 4、文件指示。 ..............................................................................................................14 5、注释。 ......................................................................................................................14 二、Makefile的文件名 ........................................................................................................15 三、引用其它的Makefile ....................................................................................................15 四、环境变量 MAKEFILES................................................................................................16 五、make的工作方式..........................................................................................................16 第五部分、书写规则.....................................................................................................................17 一、规则举例.........................................................................................................................17 二、规则的语法.....................................................................................................................17 三、在规则中使用通配符.....................................................................................................18 四、文件搜寻.........................................................................................................................19 五、伪目标.............................................................................................................................20 六、多目标.............................................................................................................................22 七、静态模式.........................................................................................................................22 八、自动生成依赖性.............................................................................................................24 第六部分 书写命令.......................................................................................................................25 一、显示命令.........................................................................................................................26 二、命令执行.........................................................................................................................26 三、命令出错.........................................................................................................................27 四、嵌套执行make..............................................................................................................28 五、定义命令包.....................................................................................................................30 第七部分 使用变量.......................................................................................................................30 一、变量的基础.....................................................................................................................31 二、变量中的变量.................................................................................................................32 三、变量高级用法.................................................................................................................34 四、追加变量值.....................................................................................................................37 五、override 指示符 ..........................................................................................................37 六、多行变量.........................................................................................................................38 第 2 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 3.跟我一起写 Makefile 作者:陈皓 七、环境变量.........................................................................................................................38 八、目标变量.........................................................................................................................39 九、模式变量.........................................................................................................................40 第八部分 使用条件判断...............................................................................................................40 一、示例.................................................................................................................................40 二、语法.................................................................................................................................42 第九部分 使用函数.......................................................................................................................43 一、函数的调用语法.............................................................................................................44 二、字符串处理函数.............................................................................................................44 1、subst .......................................................................................................................44 2、patsubst.................................................................................................................45 3、strip .........................................................................................................................45 4、findstring ...............................................................................................................46 5、filter.........................................................................................................................46 6、filter-out.................................................................................................................46 7、sort ..........................................................................................................................47 8、word ........................................................................................................................47 9、wordlist ..................................................................................................................47 10、words....................................................................................................................47 11、firstword..............................................................................................................48 12、字符串函数实例....................................................................................................48 三、文件名操作函数.............................................................................................................48 1、dir.............................................................................................................................48 2、notdir ......................................................................................................................48 3、suffix .......................................................................................................................49 4、basename..............................................................................................................49 5、addsuffix................................................................................................................49 6、addprefix ...............................................................................................................49 7、join...........................................................................................................................50 四、foreach 函数................................................................................................................50 五、if 函数 ............................................................................................................................50 六、call函数 ..........................................................................................................................51 七、origin函数 .....................................................................................................................51 “undefined” .................................................................................................................52 “default” .......................................................................................................................52 “file” ...............................................................................................................................52 “command line”.........................................................................................................52 “override” ....................................................................................................................52 “automatic” .................................................................................................................52 八、shell函数 .......................................................................................................................53 九、控制make的函数..........................................................................................................53 1、error ........................................................................................................................53 2、warning ..................................................................................................................54 第十部分 make 的运行..............................................................................................................54 第 3 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 4.跟我一起写 Makefile 作者:陈皓 一、make的退出码..............................................................................................................54 二、指定Makefile ................................................................................................................54 三、指定目标.........................................................................................................................55 “all” ................................................................................................................................56 “clean” ..........................................................................................................................56 “install” .........................................................................................................................56 “print” ...........................................................................................................................56 “tar” ...............................................................................................................................56 “dist”..............................................................................................................................56 “TAGS” ..........................................................................................................................56 “check”和“test” ..........................................................................................................56 四、检查规则.........................................................................................................................57 五、make的参数..................................................................................................................57 第十一部分 隐含规则...................................................................................................................61 一、使用隐含规则.................................................................................................................61 二、隐含规则一览.................................................................................................................62 1、编译C程序的隐含规则 ...........................................................................................63 2、编译C++程序的隐含规则 .....................................................................................63 3、编译Pascal程序的隐含规则..................................................................................63 4、编译Fortran/Ratfor程序的隐含规则..................................................................63 5、预处理Fortran/Ratfor程序的隐含规则..............................................................63 6、编译Modula-2 程序的隐含规则...........................................................................63 7、汇编和汇编预处理的隐含规则 ..............................................................................64 8、链接Object文件的隐含规则 .................................................................................64 9、Yacc C程序时的隐含规则 .....................................................................................64 10、Lex C程序时的隐含规则.....................................................................................64 11、Lex Ratfor程序时的隐含规则 ...........................................................................65 12、从C程序、Yacc文件或Lex文件创建Lint库的隐含规则 ..................................65 三、隐含规则使用的变量.....................................................................................................65 1、关于命令的变量。 ..................................................................................................65 2、关于命令参数的变量 ..............................................................................................66 四、隐含规则链.....................................................................................................................67 五、定义模式规则.................................................................................................................68 1、模式规则介绍 ..........................................................................................................68 2、模式规则示例 ..........................................................................................................69 3、自动化变量 ..............................................................................................................70 4、模式的匹配 ..............................................................................................................72 5、重载内建隐含规则 ..................................................................................................72 六、老式风格的"后缀规则" .................................................................................................73 七、隐含规则搜索算法.........................................................................................................74 第十二部分 使用make更新函数库文件....................................................................................75 一、函数库文件的成员.........................................................................................................75 二、函数库成员的隐含规则.................................................................................................75 三、函数库文件的后缀规则.................................................................................................76 第 4 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 5.跟我一起写 Makefile 作者:陈皓 四、注意事项.........................................................................................................................76 第十三部分 后序...........................................................................................................................77 第 5 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 6.跟我一起写 Makefile 作者:陈皓 第一部分、概述 什么是 makefile?或许很多 Winodws 的程序员都不知道这个东西,因为那些 Windows 的 IDE 都为你做了这个工作,但我觉得要作一个好的和 professional 的程序员,makefile 还是要懂。这就好像现在有这么多的 HTML 的编辑器,但如果你想成为一个专业人士,你还 是要了解 HTML 的标识的含义。特别在 Unix 下的软件编译,你就不能不自己写 makefile 了, 会不会写 makefile,从一个侧面说明了一个人是否具备完成大型工程的能力。 因为, makefile 关系到了整个工程的编译规则。一个工程中的源文件不计数,其按类型、功能、 模块分别放在若干个目录中,makefile 定义了一系列的规则来指定,哪些文件需要先编译, 哪些文件需要后编译,哪些文件需要重新编译,甚至于进行更复杂的功能操作,因为 makefile 就像一个 Shell 脚本一样,其中也可以执行操作系统的命令。 makefile 带来的好 处就是——“自动化编译”,一旦写好,只需要一个 make 命令,整个工程完全自动编译, 极大的提高了软件开发的效率。make 是一个命令工具,是一个解释 makefile 中指令的命令 工具,一般来说,大多数的 IDE 都有这个命令,比如:Delphi 的 make,Visual C++的 nmake, Linux 下 GNU 的 make。可见,makefile 都成为了一种在工程方面的编译方法。 现在讲述如何写 makefile 的文章比较少,这是我想写这篇文章的原因。当然,不同产 商的 make 各不相同,也有不同的语法,但其本质都是在“文件依赖性”上做文章,这里, 我仅对 GNU 的 make 进行讲述,我的环境是 RedHat Linux 8.0,make 的版本是 3.80。必竟, 这个 make 是应用最为广泛的,也是用得最多的。而且其还是最遵循于 IEEE 1003.2-1992 标 准的(POSIX.2)。 在这篇文档中,将以 C/C++的源码作为我们基础,所以必然涉及一些关于 C/C++的编译 的知识,相关于这方面的内容,还请各位查看相关的编译器的文档。这里所默认的编译器是 UNIX 下的 GCC 和 CC。 第二部分、关于程序的编译和链接 在此,我想多说关于程序编译的一些规范和方法,一般来说,无论是 C、C++、还是 pas, 首先要把源文件编译成中间代码文件,在 Windows 下也就是 .obj 文件,UNIX 下是 .o 文 件,即 Object File,这个动作叫做编译(compile)。然后再把大量的 Object File 合成执 行文件,这个动作叫作链接(link) 。 编译时,编译器需要的是语法的正确,函数与变量的 声明的正确。对于后者,通常是你需要告诉编译器头文件的所在位置(头文件中应该只是声 明,而定义应该放在 C/C++文件中) ,只要所有的语法正确,编译器就可以编译出中间目标 文件。一般来说,每个源文件都应该对应于一个中间目标文件(O 文件或是 OBJ 文件)。链 接时,主要是链接函数和全局变量,所以,我们可以使用这些中间目标文件(O 文件或是 OBJ 文件)来链接我们的应用程序。链接器并不管函数所在的源文件,只管函数的中间目标文件 (Object File),在大多数时候,由于源文件太多,编译生成的中间目标文件太多,而在链 第 6 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 7.跟我一起写 Makefile 作者:陈皓 接时需要明显地指出中间目标文件名,这对于编译很不方便,所以,我们要给中间目标文件 打个包,在 Windows 下这种包叫“库文件”(Library File),也就是 .lib 文件,在 UNIX 下,是 Archive File,也就是 .a 文件。 总结一下,源文件首先会生成中间目标文件,再由中间目标文件生成执行文件。在编译 时,编译器只检测程序语法,和函数、变量是否被声明。如果函数未被声明,编译器会给出 一个警告,但可以生成 Object File。而在链接程序时,链接器会在所有的 Object File 中 找寻函数的实现,如果找不到,那到就会报链接错误码(Linker Error) ,在 VC 下,这种错 误一般是:Link 2001 错误,意思说是说,链接器未能找到函数的实现。你需要指定函数的 Object File. 好,言归正传,GNU 的 make 有许多的内容,闲言少叙,还是让我们开始吧。 第三部分、Makefile 介绍 make 命令执行时,需要一个 Makefile 文件,以告诉 make 命令需要怎么样的去编译和 链接程序。 首先,我们用一个示例来说明 Makefile 的书写规则。以便给大家一个感兴认识。这个 示例来源于 GNU 的 make 使用手册,在这个示例中,我们的工程有 8 个 C 文件,和 3 个头文 件,我们要写一个 Makefile 来告诉 make 命令如何编译和链接这几个文件。我们的规则是: 1)如果这个工程没有编译过,那么我们的所有 C 文件都要编译并被链接。 2)如果这个工程的某几个 C 文件被修改,那么我们只编译被修改的 C 文件,并链接目 标程。 3)如果这个工程的头文件被改变了,那么我们需要编译引用了这几个头文件的 C 文件, 并链接目标程序。 只要我们的 Makefile 写得够好,所有的这一切,我们只用一个 make 命令就可以完成, make 命令会自动智能地根据当前的文件修改的情况来确定哪些文件需要重编译,从而自己 编译所需要的文件和链接目标程序。 一、Makefile 的规则 在讲述这个 Makefile 之前,还是让我们先来粗略地看一看 Makefile 的规则。 target ... : prerequisites ... command 第 7 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 8.跟我一起写 Makefile 作者:陈皓 ... ... target 也就是一个目标文件,可以是 Object File,也可以是执行文件。还可以是一个 标签(Label),对于标签这种特性,在后续的“伪目标”章节中会有叙述。 prerequisites 就是,要生成那个 target 所需要的文件或是目标。 command 也就是 make 需要执行的命令。 (任意的 Shell 命令) 这是一个文 件的依赖关 系,也就是 说,target 这一个或多 个的目标文 件依赖于 prerequisites 中的文件,其生成规则定义在 command 中。说白一点就是说,prerequisites 中如果有一个以上的文件比 target 文件要新的话,command 所定义的命令就会被执行。这 就是 Makefile 的规则。也就是 Makefile 中最核心的内容。 说到底,Makefile 的东西就是这样一点,好像我的这篇文档也该结束了。呵呵。还不 尽然,这是 Makefile 的主线和核心,但要写好一个 Makefile 还不够,我会以后面一点一点 地结合我的工作经验给你慢慢到来。内容还多着呢。:) 二、一个示例 正如前面所说的,如果一个工程有 3 个头文件,和 8 个 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 第 8 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 9.跟我一起写 Makefile 作者:陈皓 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”或“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 命令。那么, 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 了。 这就是整个 make 的依赖性,make 会一层又一层地去找文件的依赖关系,直到最终编译 第 9 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 10.跟我一起写 Makefile 作者:陈皓 出第一个目标文件。在找寻的过程中,如果出现错误,比如最后被依赖的文件找不到,那么 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 会被重链接。 四、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 中) 。当然, 我们的 makefile 并不复杂,所以在两个地方加也不累,但如果 makefile 变得复杂,那么我 们就有可能会忘掉一个需要加入的地方,而导致编译失败。所以,为了 makefile 的易维护, 在 makefile 中我们可以使用变量。makefile 的变量也就是一个字符串,理解成 C 语言中的 宏可能会更好。 比如,我们声明一个变量,叫 objects, OBJECTS, objs, OBJS, obj, 或是 OBJ,反正 不管什么啦,只要能够表示 obj 文件就行了。我们在 makefile 一开始就这样定义: objects = main.o kbd.o command.o display.o \ insert.o search.o files.o utils.o 于是,我们就可以很方便地在我们的 makefile 中以“$(objects)”的方式来使用这个 变量了,于是我们的改良版 makefile 就变成下面这个样子: 第 10 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 11.跟我一起写 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 : 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 文件加入,我们只需简单地修改一下 objects 变量就可以了。 关于变量更多的话题,我会在后续给你一一道来。 五、让 make 自动推导 GNU 的 make 很强大,它可以自动推导文件以及文件依赖关系后面的命令,于是我们就没必 要去在每一个[.o]文件后都写上类似的命令,因为,我们的 make 会自动识别,并自己推导 命令。 只要 make 看到一个[.o]文件,它就会自动的把[.c]文件加在依赖关系中,如果 make 找到一个 whatever.o,那么 whatever.c,就会是 whatever.o 的依赖文件。并且 cc -c whatever.c 也会被推导出来,于是,我们的 makefile 再也不用写得这么复杂。我们的是新 的 makefile 又出炉了。 第 11 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 12.跟我一起写 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) 这种方法,也就是 make 的“隐晦规则”。上面文件内容中,“.PHONY”表示,clean 是个伪目标文件。 关于更为详细的“隐晦规则”和“伪目标文件”,我会在后续给你一一道来。 六、另类风格的 makefile 即然我们的 make 可以自动推导命令,那么我看到那堆[.o]和[.h]的依赖就有点不爽, 那么多的重复的[.h],能不能把其收拢起来,好吧,没有问题,这个对于 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) 第 12 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 13.跟我一起写 Makefile 作者:陈皓 这种风格,让我们的 makefile 变得很简单,但我们的文件依赖关系就显得有点凌乱了。 鱼和熊掌不可兼得。还看你的喜好了。我是不喜欢这种风格的,一是文件的依赖关系看不清 楚,二是如果文件一多,要加入几个新的.o 文件,那就理不清楚了。 七、清空目标文件的规则 每个 Makefile 中都应该写一个清空目标文件(.o 和执行文件)的规则,这不仅便于重 编译,也很利于保持文件的清洁。这是一个“修养”(呵呵,还记得我的《编程修养》吗)。 一般的风格都是:clean:rm edit $(objects) 更为稳健的做法是: .PHONY : clean clean : -rm edit $(objects) 前面说过,.PHONY 意思表示 clean 是一个“伪目标”, 。而在 rm 命令前面加了一个小 减号的意思就是,也许某些文件出现问题,但不要管,继续做后面的事。当然,clean 的规 则不要放在文件的开头,不然,这就会变成 make 的默认目标,相信谁也不愿意这样。不成 文的规矩是——“clean 从来都是放在文件的最后”。 上面就是一个 makefile 的概貌,也是 makefile 的基础,下面还有很多 makefile 的相 关细节,准备好了吗?准备好了就来。 第四部分、Makefile 总述 一、Makefile 里有什么? 第 13 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 14.跟我一起写 Makefile 作者:陈皓 Makefile 里主要包含了五个东西:显式规则、隐晦规则、变量定义、文件指示和注释。 1、显式规则。 显式规则说明了,如何生成一个或多的的目标文件。这是由 Makefile 的书写者明显指 出,要生成的文件,文件的依赖文件,生成的命令。 2、隐晦规则。 由于我们的 make 有自动推导的功能,所以隐晦的规则可以让我们比较粗糙地简略地书 写 Makefile,这是由 make 所支持的。 3、变量的定义。 在 Makefile 中我们要定义一系列的变量,变量一般都是字符串,这个有点你 C 语言中 的宏,当 Makefile 被执行时,其中的变量都会被扩展到相应的引用位置上。 4、文件指示。 其包括了三个部分,一个是在一个 Makefile 中引用另一个 Makefile,就像 C 语言中的 include 一样;另一个是指根据某些情况指定 Makefile 中的有效部分,就像 C 语言中的预 编译#if 一样;还有就是定义一个多行的命令。有关这一部分的内容,我会在后续的部分中 讲述。 5、注释。 Makefile 中只有行注释,和 UNIX 的 Shell 脚本一样,其注释是用“#”字符,这个就 像 C/C++中的“//”一样。如果你要在你的 Makefile 中使用“#”字符,可以用反斜框进行 转义,如:“\#”。 最后,还值得一提的是,在 Makefile 中的命令,必须要以[Tab]键开始。 第 14 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 15.跟我一起写 Makefile 作者:陈皓 二、Makefile 的文件名 默认的情况下,make 命令会在当前目录下按顺序找寻文件名为“GNUmakefile”、 “makefile”、“Makefile”的文件,找到了解释这个文件。在这三个文件名中,最好使用 “Makefile”这个文件名,因为,这个文件名第一个字符为大写,这样有一种显目的感觉。 最好不要用“GNUmakefile”,这个文件是 GNU 的 make 识别的。有另外一些 make 只对全小 写的“makefile”文件名敏感,但是基本上来说,大多数的 make 都支持“makefile”和 “Makefile”这两种默认文件名。 当 然 , 你 可 以 使 用 别 的 文 件 名 来 书 写 Makefile , 比 如 : “Make.Linux” , “Make.Solaris”,“Make.AIX”等,如果要指定特定的 Makefile,你可以使用 make 的 “-f”和“--file”参数,如:make -f Make.Linux 或 make --file Make.AIX。 三、引用其它的 Makefile 在 Makefile 使用 include 关键字可以把别的 Makefile 包含进来,这很像 C 语言的 #include,被包含的文件会原模原样的放在当前文件的包含位置。include 的语法是: includefilename 可以是当前操作系统 Shell 的文件模式(可以保含路径和通配符)在 include 前面可以有一些空字符,但是绝不能是[Tab]键开始。include 和可以用一个或 多个空格隔开。举个例子,你有这样几个 Makefile:a.mk、b.mk、c.mk,还有一个文件叫 foo.make,以及一个变量$(bar),其包含了 e.mk 和 f.mk,那么,下面的语句: include foo.make *.mk $(bar) 等价于: include foo.make a.mk b.mk c.mk e.mk f.mk make 命令开始时,会把找寻 include 所指出的其它 Makefile,并把其内容安置在当前 的位。就好像 C/C++的#include 指令一样。如果文件都没有指定绝对路径或是相对路径的话, make 会在当前目录下首先寻找,如果当前目录下没有找到,那么,make 还会在下面的几个 目录下找: 1、如果 make 执行时,有“-I”或“--include-dir”参数,那么 make 就会在这个参数 所指定的目录下去寻找。 2、如果目录/include(一般是:/usr/local/bin 或/usr/include)存在的话, make 也会去找。如果有文件没有找到的话,make 会生成一条警告信息,但不会马上出现致 命错误。它会继续载入其它的文件,一旦完成 makefile 的读取,make 会再重试这些没有找 到,或是不能读取的文件,如果还是不行,make 才会出现一条致命信息。如果你想让 make 不理那些无法读取的文件,而继续执行,你可以在 include 前加一个减号“-”。 第 15 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 16.跟我一起写 Makefile 作者:陈皓 如: -include其表示,无论 include 过程中出现什么错误,都不要报错继续执行。和其它版本 make 兼 容的相关命令是 sinclude,其作用和这一个是一样的。 四、环境变量 MAKEFILES 如果你的当前环境中定义了环境变量 MAKEFILES,那么,make 会把这个变量中的值做一个类 似于 include 的动作。这个变量中的值是其它的 Makefile,用空格分隔。只是,它和 include 不同的是,从这个环境变中引入的 Makefile 的“目标”不会起作用,如果环境变量中定义 的文件发现错误,make 也会不理。 但是在这里我还是建议不要使用这个环境变量,因为只要这个变量一被定义,那么当你 使用 make 时,所有的 Makefile 都会受到它的影响,这绝不是你想看到的。在这里提这个事, 只是为了告诉大家,也许有时候你的 Makefile 出现了怪事,那么你可以看看当前环境中有 没有定义这个变量。 五、make 的工作方式 GNU 的 make 工作时的执行步骤入下: (想来其它的 make 也是类似) 1、读入所有的 Makefile。 2、读入被 include 的其它 Makefile。 3、初始化文件中的变量。 4、推导隐晦规则,并分析所有规则。 5、为所有的目标文件创建依赖关系链。 6、根据依赖关系,决定哪些目标要重新生成。 7、执行生成命令。 1-5 步为第一个阶段,6-7 为第二个阶段。第一个阶段中,如果定义的变量被使用了,那么, make 会把其展开在使用的位置。但 make 并不会完全马上展开,make 使用的是拖延战术,如 果变量出现在依赖关系的规则中,那么仅当这条依赖被决定要使用了,变量才会在其内部展 开。 当然,这个工作方式你不一定要清楚,但是知道这个方式你也会对 make 更为熟悉。有了这 个基础,后续部分也就容易看懂了。 第 16 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 17.跟我一起写 Makefile 作者:陈皓 第五部分、书写规则 规则包含两个部分,一个是依赖关系,一个是生成目标的方法。 在 Makefile 中,规则的顺序是很重要的,因为,Makefile 中只应该有一个最终目标, 其它的目标都是被这个目标所连带出来的,所以一定要让 make 知道你的最终目标是什么。 一般来说,定义在 Makefile 中的目标可能会有很多,但是第一条规则中的目标将被确立为 最终的目标。如果第一条规则中的目标有很多个,那么,第一个目标会成为最终的目标。make 所完成的也就是这个目标。 好了,还是让我们来看一看如何书写规则。 一、规则举例 foo.o : foo.c defs.h # foo 模块 cc -c -g foo.c 看到这个例子,各位应该不是很陌生了,前面也已说过,foo.o 是我们的目标,foo.c 和 defs.h 是目标所依赖的源文件,而只有一个命令“cc -c -g foo.c”(以 Tab 键开头)。 这个规则告诉我们两件事: 1、文件的依赖关系,foo.o 依赖于 foo.c 和 defs.h 的文件,如果 foo.c 和 defs.h 的 文件日期要比 foo.o 文件日期要新,或是 foo.o 不存在,那么依赖关系发生。 2、如果生成(或更新)foo.o 文件。也就是那个 cc 命令,其说明了,如何生成 foo.o 这个文件。(当然 foo.c 文件 include 了 defs.h 文件) 二、规则的语法 targets : prerequisites command ... 或是这样: targets : prerequisites ; command command ... 第 17 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 18.跟我一起写 Makefile 作者:陈皓 targets 是文件名,以空格分开,可以使用通配符。一般来说,我们的目标基本上是一 个文件,但也有可能是多个文件。 command 是命令行,如果其不与“target:prerequisites”在一行,那么,必须以[Tab 键]开头,如果和 prerequisites 在一行,那么可以用分号做为分隔。 (见上) prerequisites 也就是目标所依赖的文件(或依赖目标)。如果其中的某个文件要比目标文件要新,那么, 目标就被认为是“过时的”,被认为是需要重生成的。这个在前面已经讲过了。 如果命令太长,你可以使用反斜框(‘\’)作为换行符。make 对一行上有多少个字符 没有限制。规则告诉 make 两件事,文件的依赖关系和如何成成目标文件。 一般来说,make 会以 UNIX 的标准 Shell,也就是/bin/sh 来执行命令。 三、在规则中使用通配符 如果我们想定义一系列比较类似的文件,我们很自然地就想起使用通配符。make 支持 三各通配符:“*”,“?”和“[...]”。这是和 Unix 的 B-Shell 是相同的。 波浪号(“~”) 字符在文件名中也有比较特殊的用途。如果是“~/test”,这就表示当前用户的$HOME 目录 下的 test 目录。而“~hchen/test”则表示用户 hchen 的宿主目录下的 test 目录。 (这些都 是 Unix 下的小知识了,make 也支持)而在 Windows 或是 MS-DOS 下,用户没有宿主目录, 那么波浪号所指的目录则根据环境变量“HOME”而定。 通配符代替了你一系列的文件,如“*.c”表示所以后缀为 c 的文件。一个需要我们注 意的是,如果我们的文件名中有通配符,如:“*”,那么可以用转义字符“\”,如“\*” 来表示真实的“*”字符,而不是任意长度的字符串。 好吧,还是先来看几个例子吧:clean:rm -f *.o 上面这个例子我不不多说了,这是操作系统 Shell 所支持的通配符。这是在命令中的通 配符。print:*.c lpr -p $? touch print 上面这个例子说明了通配符也可以在我们的规则中,目标 print 依赖于所有的[.c]文 件。其中的“$?”是一个自动化变量,我会在后面给你讲述。 objects = *.o 上面这个例子,表示了,通符同样可以用在变量中。并不是说[*.o]会展开,不!objects 的值就是“*.o”。Makefile 中的变量其实就是 C/C++中的宏。如果你要让通配符在变量中 展开,也就是让 objects 的值是所有[.o]的文件名的集合,那么,你可以这样: 第 18 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 19.跟我一起写 Makefile 作者:陈皓 objects := $(wildcard *.o) 这种用法由关键字“wildcard”指出,关于 Makefile 的关键字,我们将在后面讨论。 四、文件搜寻 在一些大的工程中,有大量的源文件,我们通常的做法是把这许多的源文件分类,并存 放在不同的目录中。所以,当 make 需要去找寻文件的依赖关系时,你可以在文件前加上路 径,但最好的方法是把一个路径告诉 make,让 make 在自动去找。 Makefile 文件中的特殊变量“VPATH”就是完成这个功能的,如果没有指明这个变量, make 只会在当前的目录中去找寻依赖文件和目标文件。如果定义了这个变量,那么,make 就会在当当前目录找不到的情况下,到所指定的目录中去找寻文件了。 VPATH =src:../headers上面的的定义指定两个目录,“src”和“../headers”,make 会按照这个顺序进行搜 索。目录由“冒号”分隔。(当然,当前目录永远是最高优先搜索的地方) 另一个设置文件搜索路径的方法是使用 make 的“vpath”关键字(注意,它是全小写 的),这不是变量,这是一个 make 的关键字,这和上面提到的那个 VPATH 变量很类似,但是 它更为灵活。它可以指定不同的文件在不同的搜索目录中。这是一个很灵活的功能。它的使 用方法有三种: 1、vpath为符合模式的文件指定搜索目录。 2、vpath清除符合模式的文件的搜索目录。 3、vpath 清除所有已被设置好了的文件搜索目录。 vapth 使用方法中的需要包含“%”字符。“%”的意思是匹配零或若干字符, 例如,“%.h”表示所有以“.h”结尾的文件。指定了要搜索的文件集,而则指定了的文件集的搜索的目录。例如: vpath %.h ../headers 该语句表示,要求 make 在“../headers”目录下搜索所有以“.h”结尾的文件。 (如果 某文件在当前目录没有找到的话) 第 19 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 20.跟我一起写 Makefile 作者:陈皓 我们可以连续地使用 vpath 语句,以指定不同搜索策略。如果连续的 vpath 语句中出现 了相同的,或是被重复了的,那么,make 会按照 vpath 语句的先后顺 序来执行搜索。如: vpath %.c foo vpath % blish vpath %.c bar 其表示“.c”结尾的文件,先在“foo”目录,然后是“blish”,最后是“bar”目录。 vpath %.cfoo:barvpath % blish 而上面的语句则表示“.c”结尾的文件,先在“foo”目录,然后是“bar”目录,最后 才是“blish”目录。 五、伪目标 最早先的一个例子中,我们提到过一个“clean”的目标,这是一个“伪目标”,clean:rm *.o temp 正像我们前面例子中的“clean”一样,即然我们生成了许多文件编译文件,我们也应 该提供一个清除它们的“目标”以备完整地重编译而用。 (以“make clean”来使用该目 标) 因为,我们并不生成“clean”这个文件。“伪目标”并不是一个文件,只是一个标签, 由于“伪目标”不是文件,所以 make 无法生成它的依赖关系和决定它是否要执行。我们只 有通过显示地指明这个“目标”才能让其生效。当然,“伪目标”的取名不能和文件名重名, 不然其就失去了“伪目标”的意义了。 当然,为了避免和文件重名的这种情况,我们可以使用一个特殊的标记“.PHONY”来显 示地指明一个目标是“伪目标”,向 make 说明,不管是否有这个文件,这个目标就是“伪 目标”。 .PHONY : clean 只要有这个声明,不管是否有“clean”文件,要运行“clean”这个目标,只有“make clean”这样。于是整个过程可以这样写: 第 20 页共 78 页 2005 年 10 月 14 日整理:祝冬华
- 21.跟我一起写 Makefile 作者:陈皓 .PHONY:'>PHONY: