「GUN make」- 编写 Makefile文件

问题描述

内容:关于 makefile 的语法规则;

解决方案

Makefile 编写入门教程
https://mp.weixin.qq.com/s/OYYZL7EWru1Np0-1lVEvoA

关于 make 命令相关内容,参见另外一篇文章,点击查看;

Doc: https://www.gnu.org/software/make/manual/ 手册也就 200 页多一点;

阮一峰: http://www.ruanyifeng.com/blog/2015/02/make.html 博客写很好的;

关于更过 makefile 文件的内容,需要看文档。我们自己把文档打印了一份,方便查阅;

快速开始

基本 Makefile 结构实例:

ipl.bin : ipl.nas Makefile
	../z_tools/nask.exe ipl.nas ipl.bin ipl.lst

如果想要制作 ipl.bin 就要具有 ipl.nas 与 Makefile 文件。如果具有里这两个文件,则执行执行下一行的命令;

  简单的说,makefile 定义了一系列的规则来指定,哪些文件需要先编译,哪些文件需要后编译,哪些文件需要重新编译,甚至可以在 makefile 中执行 shell 脚本。makefile 带来的好处就是——“自动化编译”,一旦写好,只需要一个 make 命令,整个工程完全自动编译,极大的提高了软件开发的效率;

  关于程序的编译和链接

  一般来说,无论是 C 还是 C++,首先要把源文件编译成中间代码文件,在 Windows 下也就是 .obj 文件,UNIX 下是 .o 文件,即 Object File,这个动作叫做编译(compile),一般来说,每个源文件都应该对应于一个中间目标文件(O 文件或是 OBJ 文件)。然后再把大量的 Object File 合成执行文件,这个动作叫作链接(link);

  编译时,编译器需要的是语法的正确,函数与变量的声明的正确。对于后者,通常是你需要告诉编译器头文件的所在位置(头文件中应该只是声明,而定义应该放在 C/C++文件中),只要所有的语法正确,编译器就可以编译出中间目标文件;

  链接时,主要是链接函数和全局变量,所以,我们可以使用这些中间目标文件(O 文件或是 OBJ 文件)来链接我们的应用程序。链接器并不管函数所在的源文件,只管函数的中间目标文件(Object File),在大多数时候,由于源文件太多,编译生成的中间目标文件太多,而在链接时需要明显地指出中间目标文件名,这对于编译很不方便,所以,我们要给中间目标文件打个包,在 Windows 下这种包叫“库文件”(Library File),也就是 .lib 文件,在 UNIX 下,是 Archive File,也就是 .a 文件;

  下面我们开始看看如何自己写出 makefile;

  Makefile 的规则

  目标 : 需要的条件注意:冒号两边有空格)

命令注意:前面用 tab 键开头)

  解释一下:

  1 目标可以是一个或多个,可以是 Object File,也可以是执行文件,甚至可以是一个标签;

  2 需要的条件就是生成目标所需要的文件或目标

  3 命令就是生成目标所需要执行的脚本

  总结一下,就是说一条 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
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 就可以进行编译,执行 make clean 就可以删除所有目标文件。解释一下,也就是说生成最终的目标文件 edit,依赖于一系列的.o 目标文件,而这些.o 文件又是需要用源文件来编译生成的;

  需要注意的是,clean 后面没有条件,而 clean 本身也不是文件,它只不过是一个动作名字,其冒号后什么也没有,那么,make 就不会自动去找文件的依赖性,也就不会自动执行其后所定义的命令;

  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 了;

  makefile 中使用变量

  前面的知识已经足以让你自己完成一个简单的 makefile 了,不过 makefile 的精妙之处远不止如此,下面来看看如何在 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 = main.o kbd.o command.o display.o /

insert.o search.o files.o utils.o

  这样一来,原来的 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 又出炉了;

  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

  clean :

rm edit $(objects)

  当然,如果你觉得那么多[.o]和[.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

clean :
rm edit $(objects)

  不过话说回来,我们并不推荐这种方法。虽然简单,但是这种方法破坏了文件本身的依赖关系。如果文件过多的话,可能你自己都不清楚了;

参考文献

A Simple Makefile Tutorial: http://www.cs.colby.edu/maxwell/courses/tutorials/maketutor/
如何自己编写 Makefile: http://www.cnblogs.com/luchen927/archive/2012/02/05/2339002.html
跟我一起写 Makefile(一): http://blog.csdn.net/haoel/article/details/2886