Makefile 学习 1 - 基于若干 Blog 的汇总

基于若干 Blog 汇总的 makefile 教程

陈皓 http://www.javashuo.com/article/p-sfuuzyix-mm.html

Makefile 基础知识

1. 什么是 Makefile?

规定软件工程的编译规则。一个工程中的源文件，其按类型、功能、模块分别放在若干个目录中，makefile 定义了一系列的规则来指定，哪些文件须要先编译，哪些文件须要后编译，哪些文件须要从新编译，甚至于进行更复杂的功能操做，由于 makefile 就像一个Shell脚本同样，其中也能够执行操做系统的命令。makefile 带来的好处就是——“自动化编译”，一旦写好，只须要一个 make 命令，整个工程彻底自动编译，极大的提升了软件开发的效率。

2. 程序的编译和连接

程序编译过程： 源文件 --- 编译 compile ---> 中间代码文件 .obj (windows) .o (unix) --- 连接 link ---> 可执行文件 .exe

编译：语法的正确；函数与变量的声明的正确。对于后者，一般是你须要告诉编译器头文件的所在位置（头文件中应该只是声明，而定义应该放在C/C++文件中），只要全部的语法正确，编译器就能够编译出中间目标文件。通常来讲，每一个源文件都应该对应于一个中间目标文件（O文件或是OBJ文件）。

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

总结：源文件首先会生成中间目标文件，再由中间目标文件生成执行文件。在编译时，编译器只检测程序语法，和函数、变量是否被声明。若是函数未被声明，编译器会给出一个警告，但能够生成Object File。而在连接程序时，连接器会在全部的Object File中找寻函数的实现，若是找不到，那到就会报连接错误码（Linker Error）

3. Makefile 规则

Makefile 文件模板 -

target (目标文件，object file，exe file or Label) ：prerequisites （要生成 target 文件所须要的文件或者目标）…..
command (make 要执行的 shell 命令)

………

这是一个文件的依赖关系，也就是说，target 这一个或多个的目标文件依赖于 prerequisites 中的文件，其生成规则定义在 command 中。说白一点就是说，prerequisites 中若是有一个以上的文件比target文件要新的话，command 所定义的命令就会被执行。这就是 Makefile 的规则。也就是Makefile 中最核心的内容。

4. Makefile example

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

explain:

main.o (target file, example is object file): main.c defs.h (prerequisites: to compile this object file, main.c and defs.h is needed)  
(command line should start with a Tab)cc -c main.c (command: shell 命令用于使用 prerequisites 用于生成 target file)

main.o : main.c defs.h  
    cc -c main.c  
kbd.o : kbd.c defs.h command.h  
    cc -c kbd.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” 的文件中，而后在该目录下直接输入命令 “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 中定义不用的编译或是和编译无关的命令，好比程序的打包，程序的备份，等等。

5. make 如何工做

在默认的方式下，也就是咱们只输入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只管文件的依赖性，即，若是在我找了依赖关系以后，冒号后面的文件仍是不在，那么对不起，我就不工做啦。 经过上述分析，咱们知道，像clean这种，没有被第一个目标文件直接或间接关联，那么它后面所定义的命令将不会被自动执行，不过，咱们能够显示要make执行。即命令——“make clean”，以此来清除全部的目标文件，以便重编译。

因而在咱们编程中，若是这个工程已被编译过了，当咱们修改了其中一个源文件，好比file.c，那么根据咱们的依赖性，咱们的目标file.o会被重编译（也就是在这个依性关系后面所定义的命令），因而file.o的文件也是最新的啦，因而file.o的文件修改时间要比edit要新，因此edit也会被从新连接了（详见edit目标文件后定义的命令）。

6. 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就变成下面这个样子：

objects = main.o kbd.o command.o display.o insert.osearch.o files.o utils.o 
edit : $(objects) 
    cc -o edit $(objects)
......
clean :
    rm edit $(objects)

7. GNU make 自动推导 command 命令

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
......
   utils.o : defs.h

   .PHONY : clean
   clean :
           rm edit $(objects)

简而言之：GNU 的推导规则即便，在已知 target 文件和 prerequisites 文件的状况下，自动推导出 command 语句
例如： 在已知目标文件 main.o 和依赖文件 defs.h 的状况下， cc -c defs.h 这个command 预计被推导出来