书写规则
规则包括依赖关系和生成目标的方法。
在makefile中首先要保证只有一个最终目标,其他目标都是在这个基础上被延伸出来的,一般来说一个makefile文件可能会有很多目标文件,但是第一条将被认为是最终目标。
一、规则举例
foo.o : foo.c defs.h # foo 模块
cc -c -g foo.c
上面这个例子,foo.o是目标,foo.c 和 defs.h是依赖文件,cc -c -g foo.c 是命令(需要以TAB键开头)。
可以看出两件事:
- 文件的依赖关系:如果 foo.c 和 defs.h 的文件日期要比 foo.o 文件日期要新,或是 foo.o 不存在,那么依赖关系发生。
- 如果生成foo.o文件:第二行的命令说明了如何生成foo.o文件。
二、规则的语法
targets : prerequisites
command
...
#或是这样:
targets : prerequisites ; command
command
...
targets是文件名,以空格隔开,可以使用通配符。一般来说是一个文件,但是也有可能是多个文件。
command是命令行,可以使用上面两种方法,但使用第一种方法时要用分号做分割,如果依赖文件要比目标文件更新,那么目标文件时需要重新生成的。
如果命令很长可以使用反斜杠作为换行符,‘\’。
三、在规则中使用通配符
make 支持三种通配符:“*”,“?”和“[…]”。’~'代表家目录。如“~/test”代表家目录文件下的test目录。
“*.c”代表所有的.c文件,如果文件名中有通配符,可以使用转义字符的方法来表示真正的*。
#好吧,还是先来看几个例子吧:
clean:
rm -f *.o
#上面这个例子我不不多说了,这是操作系统 Shell 所支持的通配符。这是在命令中的通配符。
print: *.c
lpr -p $?
touch print
上面的例子,print依赖所有的.c文件,其中$?是自动化变量。
objects = *.o
同样通配符也可以使用在变量中,但是上面这种方法不是会让*.o展开为所有的.o文件,如果想展开为所有的.O文件的话
objects := $(wildcard *.o)
四、文件搜寻
在一些大的工程里,为了方便管理,经常习惯把文件分类存放,这就涉及到make寻找依赖关系时,需要在文件前面加上路径。但是最好的方法是把一个路径告诉make,让make去自动的寻找,这个时候需要涉及到环境变量。
makefile中的“VPATH”就是完成这个功能的,如果没有配置这个环境变量,那么make默认是到当前目录下寻找的,如果配置了那么如果当前目录没有的话,就会到指定目录去寻找了。
VPATH = src:../headers
上面这个例子里面有两个目录,一个是“src”一个是“…/headers”,目录由“:”分割。
另外一个设置文件搜索路径的方法是使用make的“vpath”关键字,他的使用方法是三种
-
vpath
为符合模式的文件指定搜索目录
-
vpath
清除符合模式的文件的搜索目录。
-
vpath
清除所有已被设置好了的文件搜索目录。
vapth 使用方法中的需要包含“%”字符。“%”的意思是匹配零或若干字符,
例如,“%.h”表示所有以“.h”结尾的文件。指定了要搜索的文件集,而则指定了的文件集的搜索的目录。例如:
vpath %.h …/headers
该语句表示,要求 make 在“…/headers”目录下搜索所有以“.h”结尾的文件。(如果某文件在当前目录没有找到的话)
我们可以连续地使用 vpath 语句,以指定不同搜索策略。如果连续的 vpath 语句中出现了相同的,或是被重复了的,那么,make 会按照 vpath 语句的先后顺序来执行搜索。如:
vpath %.c foo vpath % blish vpath %.c bar #其表示“.c”结尾的文件,先在“foo”目录,然后是“blish”,最后是“bar”目录。 vpath %.c foo:bar vpath % blish #而上面的语句则表示“.c”结尾的文件,先在“foo”目录,然后是“bar”目录,最后 #才是“blish”目录。
五、伪目标
在最开始的时候,提到过“clean”的目标,这个就是伪目标
clean:
rm *.c temp
我们生成了许多编译文件,我们也应该提供一个清除他们的“目标”,以便可以完整的中编译而用。
我们不生成“clean”这个文件,伪目标并不是一个文件,他只是一个标签。也是由于为目标不是文件,所有make无法生成他的依赖关系,和确定他是否要执行,我们只有通过显示指出目标才能够让其生效,同时伪目标也不能和文件名重名。
为了避免和文件重名的这种情况,我们可以使用一个特殊的标记,“.PHONY”来显式的指明一个目标是伪目标。
.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”命令来达到清除不同种类文件的目的。
六、多目标
Makefile 的规则中的目标可以不止一个,其支持多目标,有可能我们的多个目标同时依赖于一个文件,并且其生成的命令大体类似。于是我们就能把其合并起来。当然,多个目标的生成规则的执行命令是同一个,这可能会可我们带来麻烦,不过好在我们的可以使用一个自动化变量“$@”(关于自动化变量,将在后面讲述),这个变量表示着目前规则中所有的目标的集合,这样说可能很抽象,还是看一个例子吧。
bigoutput littleoutput : text.g
generate text.g -$(subst output,,$@) > $@
#上述规则等价于:
bigoutput : text.g
generate text.g -big > bigoutput
littleoutput : text.g
generate text.g -little > littleoutput
其中-
(
s
u
b
s
t
o
u
t
p
u
t
,
,
(subst output,,
(substoutput,,@)中的“$”表示执行一个 Makefile 的函数,函数名为 subst,后面的为参数。
关于函数,将在后面讲述。这里的这个函数是截取字符串的意思,“$@”表示目标的集合,就像一个数组,,“$@”依次取出目标,并执于命令。
七、静态模式
静态模式可以更轻松的定义多目标的规则,可以让定义规则更加灵活。
<targets ...>: <target-pattern>: <prereq-patterns ...>
<commands>
....
-
targets 定义了一系列的目标文件,可以有通配符。是目标的一个集合。
-
target-parrtern 是指明了 targets 的模式,也就是的目标集模式。
-
prereq-parrterns 是目标的依赖模式,它对 target-parrtern 形成的模式再进行一次依赖目标的定义。
举个例子
如果 定义成“%.o”,意思是我们的集合中都是以“.o”结尾的.
如果我们的定义成“%.c”,意思是对所形成的目标集进行二次定义,其计算方法是,取模式中的“%”(也就是去掉了[.o]这个结尾),并为其加上[.c]这个结尾,形成的新集合。
所以,我们的“目标模式”或是“依赖模式”中都应该有“%”这个字符,如果你的文件名中有“%”那么你可以使用反斜杠“\”进行转义,来标明真实的“%”字符。
#看一个例子:
objects = foo.o bar.o
all: $(objects)
$(objects): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@
上面的例子中,指明了我们的目标从 o b j e c t 中 获 取 , “ object 中获取,“%.o”表明要所有以“.o”结尾的目标,也就是“foo.o bar.o”,也就是变量 object中获取,“object 集合的模式,而依赖模式“%.c”则取模式“%.o”的“%”,也就是“foo bar”,并为其加下“.c”的后缀,于是,我们的
依赖目标就是“foo.c bar.c”。而命令中的“ < ” 和 “ <”和“ <”和“@”则是自动化变量,“ < ” 表 示 所 有 的 依 赖 目 标 集 ( 也 就 是 “ f o o . c b a r . c ” ) , “ <”表示所有的依赖目标集(也就是“foo.c bar.c”),“ <”表示所有的依赖目标集(也就是“foo.cbar.c”),“@”表示目标集(也就是“foo.o bar.o”)。
于是,上面的规则展开后等价于下面的规则:
foo.o : foo.c
$(CC) -c $(CFLAGS) foo.c -o foo.o
bar.o : bar.c
$(CC) -c $(CFLAGS) bar.c -o bar.o
试想,如果我们的“%.o”有几百个,那种我们只要用这种很简单的“静态模式规则”
就可以写完一堆规则,实在是太有效率了。“静态模式规则”的用法很灵活,如果用得好,
那会一个很强大的功能。再看一个例子:
files = foo.elc bar.o lose.o
$(filter %.o,$(files)): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@
$(filter %.elc,$(files)): %.elc: %.el
emacs -f batch-byte-compile $<
( f i l t e r (filter %.o, (filter(files))表示调用 Makefile 的 filter 函数,过滤“$filter”集,只要其
中模式为“%.o”的内容。其的它内容,我就不用多说了吧。这个例字展示了 Makefile 中更
大的弹性。
八、自动生成依赖性
在 Makefile 中,我们的依赖关系可能会需要包含一系列的头文件,比如,如果我们的 main.c中有一句“#include “defs.h””,那么我们的依赖关系应该是:
main.o : main.c defs.h
但是,如果是一个比较大型的工程,你必需清楚哪些 C 文件包含了哪些头文件,并且,你在加入或删除头文件时,也需要小心地修改 Makefile,这是一个很没有维护性的工作。为了避免这种繁重而又容易出错的事情,我们可以使用 C/C++编译的一个功能。大多数的C/C++编译器都支持一个“-M”的选项,即自动找寻源文件中包含的头文件,并生成一个依赖关系。例如,如果我们执行下面的命令:
cc -M main.c
其输出是:
main.o : main.c defs.h
于是由编译器自动生成的依赖关系,这样一来,你就不必再手动书写若干文件的依赖关系,而由编译器自动生成了。需要提醒一句的是,如果你使用 GNU 的 C/C++编译器,你得用“-MM”参数,不然,“-M”参数会把一些标准库的头文件也包含进来。
gcc -M main.c
的输出是:
main.o: main.c defs.h /usr/include/stdio.h /usr/include/features.h \
/usr/include/sys/cdefs.h /usr/include/gnu/stubs.h \
/usr/lib/gcc-lib/i486-suse-linux/2.95.3/include/stddef.h \
/usr/include/bits/types.h /usr/include/bits/pthreadtypes.h \
/usr/include/bits/sched.h /usr/include/libio.h \
/usr/include/_G_config.h /usr/include/wchar.h \
/usr/include/bits/wchar.h /usr/include/gconv.h \
/usr/lib/gcc-lib/i486-suse-linux/2.95.3/include/stdarg.h \
/usr/include/bits/stdio_lim.h
gcc -MM main.c
的输出则是:
main.o: main.c defs.h
那么,编译器的这个功能如何与我们的 Makefile 联系在一起呢。因为这样一来,我们的 Makefile 也要根据这些源文件重新生成,让 Makefile 自已依赖于源文件?这个功能并不现实,不过我们可以有其它手段来迂回地实现这一功能。GNU 组织建议把编译器为每一个源文件的自动生成的依赖关系放到一个文件中,为每一个“name.c”的文件都生成一个“name.d”的 Makefile 文件,[.d]文件中就存放对应[.c]文件的依赖关系。于是,我们可以写出[.c]文件和[.d]文件的依赖关系,并让 make 自动更新或自成[.d]文件,并把其包含在我们的主 Makefile 中,这样,我们就可以自动化地生成每个文件的依赖关系了。
这里,我们给出了一个模式规则来产生[.d]文件:
%.d: %.c
@set -e; rm -f $@; \
$(CC) -M $(CPPFLAGS) $< > $@.$$$$; \
sed 's,\($*\)\.o[ :]*,\1.o $@ : ,g' < $@.$$$$ > $@; \
rm -f $@.$$$$
这个规则的意思是,所有的[.d]文件依赖于[.c]文件,“rm -f @ ” 的 意 思 是 删 除 所 有 的 目 标 , 也 就 是 [ . d ] 文 件 , 第 二 行 的 意 思 是 , 为 每 个 依 赖 文 件 “ @”的意思是删除所有的目标,也就是[.d]文件,第二行的意思是,为每个依赖文件“ @”的意思是删除所有的目标,也就是[.d]文件,第二行的意思是,为每个依赖文件“<”,也就是[.c]文件生成依赖文件,“ @ ” 表 示 模 式 “ @”表示模式“%.d”文件,如果有一个 C 文件是 name.c,那么“%”就是“name”,“ @”表示模式“$$$”意为一个随机编号,第二行生成的文件有可能是“name.d.12345”,第三行使用 sed 命令做了一个替换,关于 sed 命令的用法请参看相关的使用文档。第四行就是删除临时文件。
总而言之,这个模式要做的事就是在编译器生成的依赖关系中加入[.d]文件的依赖,即
把依赖关系:
main.o : main.c defs.h
转成:
main.o main.d : main.c defs.h
于是,我们的[.d]文件也会自动更新了,并会自动生成了,当然,你还可以在这个[.d]文件中加入的不只是依赖关系,包括生成的命令也可一并加入,让每个[.d]文件都包含一个完赖的规则。一旦我们完成这个工作,接下来,我们就要把这些自动生成的规则放进我们的主 Makefile 中。我们可以使用 Makefile 的“include”命令,来引入别的 Makefile 文件(前
面讲过),例如:
sources = foo.c bar.c
include $(sources:.c=.d)
上述语句中的“$(sources:.c=.d)”中的“.c=.d”的意思是做一个替换,把变量$(sources)所有[.c]的字串都替换成[.d],关于这个“替换”的内容,在后面我会有更为详细的讲述。当然,你得注意次序,因为 include 是按次来载入文件,最先载入的[.d]文件中的目标会成为默认目标。