Emacs下工程的编译：makefile

文章参考：makefile详解

个人环境介绍

ubuntu11.04操作系统

GUN Emacs 23.2.1

后面的叙述都基于上述环境。另外，本文主要针对C/C++程序开发，从难度上说，本文主要针对入门者。

基本流程

写C++程序基本上是这么几个步骤：

1. 编辑代码
2. 编写Makefile
3. 编译代码，修改编译错误
4. 调试代码，修改逻辑错误

编写Makefile

makefile实现了工程的自动编译，一旦写好，只需要一个make命令，整个工程完全自动编译，极大的提高了软件开发的效率。

其中，make是一个命令工具，是一个解释makefile中指令的命令工具。

每个项目都有自己的makefile文件。

举例：有文件fileA.cpp对应头文件fileA.h，fileB.cpp对应头文件fileB.h，main.cpp包含头文件fileA.h，fileB.h； 要求输出main可执行文件

makefile编写如下：（没有实际验证，凭经验写的，如果有错误，还请不吝赐教）

main: main.o fileA.o fileB.o
gcc main.o fileA.o fileB.o -o main

main.o: main.cpp fileA.h fileB.h
gcc -c -o main.o main.cpp

fileA.o: fileA.cpp fileA.h
gcc -c -o fileA.o fileA.cpp

fileB.o: fileB.cpp fileB.h
gcc -c -o fileB.o fileB.cpp

注意事项：

gcc前一定要有一个tab分隔符，不能有空格；

当需要换行时，可用“\”隔开；

否则会出现“makefile:2: *** 遗漏分隔符 "的错误。

详细内容:

一、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的文件名

默认的情况下，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的语法是：

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，其作用和这一个是一样的。

四、make的工作方式
GNU的make工作时的执行步骤入下：（想来其它的make也是类似）
1、读入所有的Makefile。
2、读入被include的其它Makefile。
3、初始化文件中的变量。
4、推导隐晦规则，并分析所有规则。
5、为所有的目标文件创建依赖关系链。
6、根据依赖关系，决定哪些目标要重新生成。
7、执行生成命令。

1-5步为第一个阶段，6-7为第二个阶段。

第一个阶段中，如果定义的变量被使用了，那么，make会把其展开在使用的位置。但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中最核心的内容。

六、在规则中使用通配符

可以使用通配符一系列比较类似的文件。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]的文件名的集合，那么，你可以这样：
objects := $(wildcard *.o)
这种用法由关键字“wildcard”指出，关于Makefile的关键字，我们将在后面讨论。

七、makefile中变量的引入

我们可在makefile中加入变量。另外，环境变量在make过程中也被解释成make的变量。这些变量是大小写敏感的，一般使用大写字母。Make变量可以做很多事情，例如：

i) 存储一个文件名列表；

ii) 存储可执行文件名；

iii) 存储编译器选项。

定义一个变量，只需要在一行的开始写下这个变量的名字，后面跟一个=号，再跟变量的值；

引用变量的方法是写一个$符号，后面跟（变量名）。 

上面的makefile文件可写成如下形式：

OBJS = main.o fileA.o fileB.o CC = gcc CFLAGS = -wall -o -g main : $(OBJS) $(CC) $(OBJS) -o main main.o : main.c fileA.h fileB.h $(CC) $(CFLAGS) -c main.cpp -o main.o fileA.o : fileA.c fileA.h $(CC) $(CFLAGS) -c fileA.cpp -o fileA.o fileB.o: fileB.c fileB.h $(CC) $(CFLAGS) -c fileB.cpp -o fileB.o  

八、makefile的自动推导

GNU的make很强大，它可以自动推导文件以及文件依赖关系后面的命令，于是我们就没必要去在每一个[.o]文件后都写上类似的命令，因为，我们的make会自动识别，并自己推导命令。
只要make看到一个[.o]文件，它就会自动的把[.c]文件加在依赖关系中，如果make找到一个whatever.o，那么whatever.cpp，whatever.h就会是whatever.o的依赖文件；并且命令gcc -c whatever.c 也会被推导出来。

于是，我们的makefile再也不用写得这么复杂。改写后的makefile文件。

OBJS = main.o fileA.o fileB.o CC = gcc CFLAGS = -wall -o -g main : $(OBJS) $(CC) $(OBJS) -o main main.o : fileA.h fileB.h $(CC) $(CFLAGS) -c main.cpp -o main.o 

注意：fileA.o和fileB.o的编译设置可不写出，由自动推导而来。

九、清空目标文件
每个Makefile中都应该写一个清空目标文件（.o和执行文件）的规则，这不仅便于重编译，也很利于保持文件的清洁。
一般的风格都是：

clean:
rm main $(objects)

更为稳健的做法是：

.PHONY : clean
clean :
-rm main $(objects)

.PHONY意思表示clean是一个“伪目标”( phony  ['fonɪ]，假的，欺骗的)；而在rm命令前面加 “-” 的意思就是，即便某些文件出现问题，也不要管，继续做后面的事。

clean的规则一般都是放在文件的最后。

十、文件搜寻
在一些大的工程中，有大量的源文件，我们通常的做法是把这许多的源文件分类，并存放在不同的目录中。所以，当make需要去找寻文件的依赖关系时，你可以在文件前加上路径，但最好的方法是把一个路径告诉make，让make在自动去找。

方法一：利用Makefile文件中的特殊变量“VPATH”就是完成这个功能的，如果没有指明这个变量，make只会在当前的目录中去找寻依赖文件和目标文件。如果定义了这个变量，那么，make就会在当当前目录找不到的情况下，到所指定的目录中去找寻文件了。

VPATH = src:../headers

上面的的定义指定两个目录，“src”和“../headers”，make会按照这个顺序进行搜索。 目录由“冒号”分隔。（当然，当前目录永远是最高优先搜索的地方）

方法二：设置文件搜索路径的方法是使用make的“vpath”关键字（注意，它是全小写的），这不是变量，这是一个make的关键字，这和上面提到的那个VPATH变量很类似，但是它更为灵活。它可以指定不同的文件在不同的搜索目录中。这是一个很灵活的功能。它的使用方法有三种：

1、vpath <pattern> <directories>
为符合模式<pattern>的文件指定搜索目录<directories>。
2、vpath <pattern>
清除符合模式<pattern>的文件的搜索目录。
3、vpath
清除所有已被设置好了的文件搜索目录。

vapth使用方法中的<pattern>需要包含“%”字符。“%”的意思是匹配零或若干字符，例如，“%.h”表示所有以“.h”结尾的文件；

<pattern>指定了要搜索的文件集，而<directories>则指定了<pattern>的文件集的搜索的目录。例如：

vpath %.h ../headers

该语句表示，要求make在“../headers”目录下搜索所有以“.h”结尾的文件。（如果某文件在当前目录没有找到的话）

我们可以连续地使用vpath语句，以指定不同搜索策略。如果连续的vpath语句中出现了相同的<pattern>，或是被重复了的<pattern>，那么，make会按照vpath语句的先后顺序来执行搜索。如：

vpath %.c foo
vpath %.c blish
vpath %.c bar

其表示“.c”结尾的文件，先在“foo”目录，然后是“blish”，最后是“bar”目录。

vpath %.c foo:bar
vpath % blish

而上面的语句则表示“.c”结尾的文件，先在“foo”目录，然后是“bar”目录，最后才是“blish”目录。

十一、伪目标
最早先的一个例子中，我们提到过一个“clean”的目标，这是一个“伪目标”，

clean:
rm *.o temp

正像我们前面例子中的“clean”一样，即然我们生成了许多文件编译文件，我们也应该提供一个清除它们的“目标”以备完整地重编译而用。

因为，我们并不生成“clean”这个文件。“伪目标”并不是一个文件，只是一个标签，由于“伪目标”不是文件，所以make无法生成它的依赖关系和决定它是否要执行。我们只有通过显示地指明这个“目标”才能让其生效。当然，“伪目标”的取名不能和文件名重名，不然其就失去了“伪目标”的意义了。
为了避免和文件重名的这种情况，我们可以使用一个特殊的标记“.PHONY”来显示地指明一个目标是“伪目标”，向make说明，不管是否有这个文件，这个目标就是“伪目标”。

.PHONY : clean

只要有这个声明，不管是否有“clean”文件，要运行“clean”这个目标，只有“make clean”这样。于是整个过程可以这样写：

.PHONY: clean
clean:
rm *.o temp

伪目标一般没有依赖的文件。但是，我们也可以 为伪目标指定所依赖的文件。伪目标同样可以作为“默认目标”，只要将其放在第一个。一个示例就是，如果你的Makefile需要一
口气 生成若干个可执行文件，但你只想简单地敲一个make完事，并且，所有的目标文件都
写在一个Makefile中，那么你可以使用“伪目标”这个特性：

all : prog1 prog2 prog3
.PHONY : all

prog1 : prog1.o utils.o
cc -o prog1 prog1.o utils.o

prog2 : prog2.o
cc -o prog2 prog2.o

prog3 : prog3.o sort.o utils.o
cc -o prog3 prog3.o sort.o utils.o

我们知道，Makefile中的第一个目标会被作为其默认目标。我们声明了一个“all”的伪目标，其依赖于其它三个目标。由于伪目标的特性是，总是被执行的，所以其依赖的那三个目标就总是不如“all”这个目标新。所以，其它三个目标的规则总是会被决议。也就达到了我们一口气生成多个目标的目的。

“.PHONY : all”声明了“all”这个目标为“伪目标”。
随便提一句，从上面的例子我们可以看出，目标也可以成为依赖。所以，伪目标同样也可成为依赖。看下面的例子：

.PHONY: cleanall cleanobj cleandiff
cleanall : cleanobj cleandiff
rm program
cleanobj :
rm *.o
cleandiff :
rm *.diff

“make clean”将清除所有要被清除的文件。“cleanobj”和“cleandiff”这两个伪目标有点像“子程序”的意思。我们可以输入“make cleanall”和“make cleanobj”和“make cleandiff”命令来达到清除不同种类文件的目的。

还有一些规则，但鉴于内容较多，不详细举例。参考文章有具体的描述。