make命令运行时。须要一个 makefile 文件,以告诉make命令怎样去编译和链接程序。


首先。我们用一个演示样例来说明makefile的书写规则。

以便给大家一个感性认识。这个演示样例来源于gnu的make使用手冊,在这个演示样例中。我们的project有8个c文件,和3个头文件,我们要写一个makefile来告诉make命令怎样编译和链接这几个文件。我们的规则是:
1)假设这个project没有编译过。那么我们的全部c文件都要编译并被链接。


2)假设这个project的某几个c文件被改动,那么我们仅仅编译被改动的c文件,并链接目标程序。


3)假设这个project的头文件被改变了,那么我们须要编译引用了这几个头文件的c文件,并链接目标程序。
仅仅要我们的makefile写得够好,全部的这一切,我们仅仅用一个make命令就能够完毕。make命令会自己主动智能地依据当前的文件改动的情况来确定哪些文件须要重编译。从而自己编译所须要的文件和链接目标程序。


makefile的规则
在讲述这个makefile之前,还是让我们先来粗略地看一看makefile的规则。

target ... : prerequisites ...
        command
        ...
        ...

target能够是一个object file(目标文件),也能够是一个运行文件。还能够是一个标签(label)。

对于标签这样的特性,在兴许的“伪目标”章节中会有叙述。
prerequisites就是。要生成那个target所须要的文件或是目标。

command也就是make须要运行的命令。(随意的shell命令)


这是一个文件的依赖关系,也就是说,target这一个或多个的目标文件依赖于prerequisites中的文件,其生成规则定义在 command中。说白一点就是说,prerequisites中假设有一个以上的文件比target文件要新的话,command所定义的命令就会被运行。

这就是makefile的规则。

也就是makefile中最核心的内容。


说究竟,makefile的东西就是这样一点。好像我的这篇文档也该结束了。呵呵。还不尽然,这是makefile的主线和核心,但要写好一个makefile还不够,我会以后面一点一点地结合我的工作经验给你慢慢道来。内容还多着呢。:)


一个演示样例
正如前面所说的。假设一个project有3个头文件,和8个c文件。我们为了完毕前面所述的那三个规则,我们的makefile应该是以下这个样子的。
edit : main.o kbd.o command.o display.o \
                insert.o search.o files.o utils.o       /*凝视:假设后面这些.o文件比edit可运行文件新,那么才会去运行以下这句命令*/
        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的易读。

我们能够把这个内容保存在名字为“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就不会自己主动去找它的依赖性。也就不会自己主动运行其后所定义的命令。

要运行其后的命令(不仅用于clean。其它lable相同适用),就要在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会一层又一层地去找文件的依赖关系,直到终于编译出第一个目标文件。

在找寻的过程中,假设出现错误,比方最后被依赖的文件找不到。那么make就会直接退出。并报错,而对于所定义的命令的错误。或是编译不成功,make根本不理。

make仅仅管文件的依赖性。即,假设在我找了依赖关系之后,冒号后面的文件还是不在,那么对不起,我就不工作啦。


通过上述分析。我们知道。像clean这样的。没有被第一个目标文件直接或间接关联,那么它后面所定义的命令将不会被自己主动运行,只是。我们能够显式要make运行。即命令——“make clean”,以此来清除全部的目标文件,以便重编译。
于是在我们编程中,假设这个project已被编译过了,当我们改动了当中一个源文件,比方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]文件的字符串被反复了两次,假设我们的project须要增加一个新的[.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.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
 cc = gcc


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来说非常easy,谁叫它提供了自己主动推导命令和文件的功能呢?来看看最新风格的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)


这样的风格,让我们的makefile变得非常easy。但我们的文件依赖关系就显得有点凌乱了。

鱼和熊掌不可兼得。

还看你的喜好了。我是不喜欢这样的风格的,一是文件的依赖关系看不清楚,二是假设文件一多,要增加几个新的.o文件,那就理不清楚了。


清空目标文件的规则

每一个Makefile中都应该写一个清空目标文件(.o和运行文件)的规则,这不仅便于重编译,也非常利于保持文件的清洁。这是一个“修养”(呵呵,还记得我的《编程修养》吗)。一般的风格都是:
clean:
        rm edit $(objects)
#更为稳健的做法是:
.PHONY : clean
clean :
        -rm edit $(objects)


前面说过,.PHONY意思表示clean是一个“伪目标”,。

而在rm命令前面加了一个小减号的意思就是,或许某些文件出现故障,但不要管,继续做后面的事。当然,clean的规则不要放在文件的开头。不然,这就会变成make的默认目标,相信谁也不愿意这样。

不成文的规矩是——“clean从来都是放在文件的最后”。


上面就是一个makefile的概貌,也是makefile的基础,以下还有非常多makefile的相关细节。准备好了吗?准备好了就来。



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]键開始。


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使用includekeyword能够把别的Makefile包括进来,这非常像C语言的#include,被包括的文件会原模原样的放在当前文件的包括位置。

include的语法是:
include <filename>;
filename能够是当前操作系统Shell的文件模式(能够包括路径和通配符)
在include前面能够有一些空字符,可是绝不能是[Tab]键開始。

include和<filename>;能够用一个或多个空格隔开。

举个样例,你有这样几个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. 假设文件夹<prefix>;/include(通常是:/usr/local/bin或/usr/include)存在的话,make也会去找。
假设有文件没有找到的话。make会生成一条警告信息。但不会立即出现致命错误。它会继续加载其他的文件,一旦完毕makefile的读取。 make会再重试这些没有找到。或是不能读取的文件,假设还是不行,make才会出现一条致命信息。假设你想让make不理那些无法读取的文件。而继续运行,你能够在include前加一个减号“-”。如:

-include <filename>;


其表示,不管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更为熟悉。

有了这个基础,兴许部分也就easy看懂了。


from Ubuntu wiki