书写规则包含两个部分:依赖关系、生成目标的方法。
在 Makefile 中,规则的顺序是很重要的,因为,Makefile 中只应该有一个最终目标,其它的目标都是被这个目标所连带出来的,所以一定要让 make 知道你的最终目标是什么。
一般来说,定义在 Makefile 中的目标可能会有很多,但是 第一条规则中的目标将被确立为最终的目标。如果第一条规则中的目标有很多个,那么第一个目标会成为最终的目标,make 所完成的也就是这个目标。
好了,还是让我们来看一看如何书写规则。
Ⅰ. 书写规则举例
foo.o : foo.c defs.h # foo模块
gcc -c -g foo.c 看到这个例子,各位应该不是很陌生了,前面也已说过,foo.o 是我们的目标,foo.c 和 defs.h 是目标所依赖的源文件,而只有一个命令 gcc -c -g foo.c。
注意:这里只会对 .c 文件进行处理,而 .h 文件放在这里是为了告诉其 .o 是依赖这个头文件的,这个头文件在被 make 的时候其实是不存在的!这个规则告诉我们两件事:
-
文件的依赖关系:
foo.o依赖于foo.c和defs.h的文件,如果foo.c和defs.h的文件日期要比foo.o文件日期要新,或是foo.o不存在,那么依赖关系发生,否则不会发生!
-
如何生成 (或更新)
foo.o文件:- 也就是那个
gcc命令说明了如何生成foo.o这个文件,当然也说明了foo.c文件包含了defs.h头文件。
- 也就是那个
Ⅱ. 书写规则的语法
targets : prerequisites
command
... 或者是这样:
targets : prerequisites ; command
command
...targets:文件名,多个文件用空格分开,可以使用通配符。一般来说,我们的目标基本上是一个文件,但也有可能是多个文件。command:命令行,如果其与target : prerequisites不在同一行,那么必须以Tab键开头;而如果和prerequisites在一行,那么可以用分号做为分隔。(比如上面第二种写法)prerequisites:目标所依赖的文件(或依赖目标)。如果其中的某个文件要比目标文件要新,那么,目标就被认为是过时的,被认为是需要重生成的。这个在前面已经讲过了。
如果命令太长,你可以使用反斜线 \ 作为换行符,并且 make 对一行上有多少个字符没有限制。规则告诉 make 两件事,文件的依赖关系和如何变成目标文件。
一般来说,make 会以 UNIX 的标准 Shell,也就是 /bin/sh 来执行命令。
Ⅲ. 在规则中使用通配符
如果我们想定义一系列比较类似的文件,我们很自然地就想起使用通配符。make 支持三种通配符:*、? 和 [...]。
并且波浪号
~字符在文件名中也有比较特殊的用途。如果是~/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,相当于 C/C++ 中的宏。
如果你要让通配符在变量中展开,也就是让 objects 的值是所有 .o 的文件名的集合,那么你可以这样:
objects := $(wildcard *.o) 这种用法由关键字 wildcard 指出,关于 Makefile 的关键字,我们将在后面讨论。
最后再来说说两个赋值操作的区别:
-
=-
表示
make会将整个makefile展开后,再决定变量的值。也就是说变量的值将会是整个makefile中最后被指定的值。看例子:x = foo y = $(x) bar x = xyz在上例中,
y的值将会是xyz bar,而不是foo bar。
-
-
:=-
表示变量的值会被立刻指定,而不是整个
makefile展开后的最终值。看例子:x := foo y := $(x) bar x := xyz在上例中,
y的值将会是foo bar,而不是xyz bar。
-
Ⅳ. 文件搜寻 -- VPATH && vpath
1、VPATH变量
在一些大的工程中,有大量的源文件,我们通常的做法是把这许多的源文件分类,并存放在不同的目录中。所以当 make 需要去寻找文件的依赖关系时,你可以在文件前加上路径,但最好的方法是把一个路径告诉 make,让 make 自动去找。
Makefile 文件中的特殊变量 VPATH 就是完成这个功能的,如果没有指明 VPATH 的话,make 只会在【当前目录】中去找寻依赖文件和目标文件。
如果定义了 VPATH,那么 make 就会在当前目录找不到的情况下,到所指定的目录中去寻找文件了。
其定义格式和普通变量差不多,如下所示:
VPATH = src:../headers 上面的的定义指定了两个目录,src 和 ../headers,make 会按照这个定义顺序进行搜索。路径之间由冒号 : 分隔。(但是记住当前目录永远是最高优先搜索的地方)
2、vpath关键字
另一种设置文件搜索路径的方法是使用 make 的 vpath 关键字(小写的),注意这不是变量,而是 make 的一个关键字,这和上面提到的那个 VPATH 变量很类似,但是它更为灵活!
vpath 关键字可以指定不同的文件在不同的搜索目录中,这是一个很灵活的功能。
-
vpath <pattern> <directories>- 为符合模式
<pattern>的文件指定搜索目录。此时目录之间同样也用冒号:进行分割。
- 为符合模式
-
vpath <pattern>- 清除符合模式
<pattern>的文件的搜索目录。
- 清除符合模式
-
vpath- 清除所有已被设置好了的文件搜索目录。
vapth 使用方法中的 <pattern> 需要包含 % 字符。其中 % 的意思是匹配零或若干字符,例如,%.h 表示所有以 .h 结尾的文件。
其中 <pattern> 指定了要搜索的文件集,而 <directories> 则指定了的文件集的搜索的目录,例如:
vpath %.h ../headers 该语句表示,如果某文件在当前目录没有找到的话,就去 ../headers 目录下搜索所有以 .h 结尾的文件。
我们可以连续地使用 vpath 语句,以指定不同搜索策略。如果连续的 vpath 语句中出现了相同的 <pattern>,或是被重复了的 <pattern>,那么,make 会按照 vpath 语句的先后顺序来执行搜索。如下所示:
vpath %.c foo
vpath % blish
vpath %.c bar 其表示 .c 结尾的文件,先在 foo 目录,然后是 blish,最后是 bar 目录。
vpath %.c foo:bar
vpath % blish 而上面的语句则表示 .c 结尾的文件,先在 foo 目录,然后是bar目录,最后才是 blish 目录。
3、使用举例
此处记录我在实际使用 VPATH 与 vpath 时遇见的问题。我用了一个小 demo 来使用 VPATH,目录结构如下:
tmp
├── inc
│ └── sub.h
├── makefile
└── src
├── main.c
└── sub.c main.c 和 sub.c 里都有 #include "sub.h" 。
版本一
我的第一版 Makefile 如下:
VPATH = src:inc
test : main.o sub.o
gcc -o test main.o sub.o
main.o : main.c sub.h
gcc -c main.c
sub.o : sub.c sub.h
gcc -c sub.c
.PHONY: clean
clean:
rm *.o test 执行 make 命令后报错:
gcc -c main.c
gcc: error: main.c: No such file or directory
gcc: fatal error: no input files
compilation terminated.
make: *** [makefile:7: main.o] Error 1 仔细看上面那个 gcc 命令, gcc -c main.c ,初学者经常会认为,我都在 Makefile 文件里指定了搜寻路径为 "src:inc" 了,为什么会找不到 main.c 文件呢,main.c 文件不就是在 src/ 目录下么❓❓❓
这就涉及到 VPATH 的概念理解了:当 make 需要去找寻文件的依赖关系时,你可以在文件前加上路径,但最好的方法是把一个路径告诉 make,让 make 在自动去找。
但问题就是 VPATH 和 vpath 只是在 make 寻找文件的依赖关系时才有作用,而对于 gcc -c main.c 是定义的规则所执行的命令,会原封不动地执行,该命令的意思是在当前文件夹下编译 main.c 文件,由于没有找到 main.c ,故出现上述错误。
我们可以使用 make -n 可以查看具体执行的命令:
gcc -c main.c
gcc -c sub.c
gcc -o test main.o sub.o 所以此时就需要修改一下我们的 Makefile 文件了。
版本二
第二版 Makefile 如下:
VPATH = src:inc
test : main.o sub.o
gcc -o test main.o sub.o
main.o : main.c sub.h
gcc -c $<
sub.o : sub.c sub.h
gcc -c $<
.PHONY: clean
clean:
rm *.o test 在执行命令时,使用 $< 这个自动变量,此时使用 make -n 查看具体执行的命令,可以看见 gcc 编译的文件已经自动包含目录前缀了。
gcc -c src/main.c
gcc -c src/sub.c
gcc -o test main.o sub.o 但是上述 Makefile 仍然会报错:
gcc -c src/main.c
src/main.c:1:10: fatal error: sub.h: No such file or directory
1 | #include "sub.h"
| ^~~~~~~
compilation terminated.
make: *** [makefile:7: main.o] Error 1 错误信息提示我们编译时找不到 sub.h 头文件,观察上述执行的命令,发现需要添加自定义头文件路径,也就是 "-I" 选项。所以我们再次修改一下 Makefile 文件。
版本三
第三版 Makefile 如下:
VPATH = src:inc
test : main.o sub.o
gcc -o test main.o sub.o
main.o : main.c sub.h
gcc -c $< -I inc/
sub.o : sub.c sub.h
gcc -c $< -I inc/
.PHONY: clean
clean:
rm *.o test 具体执行的命令如下:
gcc -c src/main.c -I inc/
gcc -c src/sub.c -I inc/
gcc -o test main.o sub.o 该版本 Makefile 正常执行。
Ⅴ. 伪目标
最早先的一个例子中,我们提到过一个 clean 的伪目标,如下所示:
clean:
rm *.o temp 正像我们前面例子中的 clean 一样,即然我们编译后生成了许多文件,包括生成的 .o 目标文件和可执行文件等(如果编译内核模块也会生成一些其它后缀的文件等等),我们也应该提供一个清除它们的目标以备完整地重编译而用。
因为我们并不生成 clean 这个文件,所以需要用到伪目标。伪目标 并不是一个文件,只是一个标签,由于伪目标不是文件,所以 make 无法生成它的依赖关系和决定它是否要执行。我们只有通过显示地指明这个 目标 才能让其生效,如 make clean。
此外 伪目标 的取名不能和文件名重名,不然其就失去了伪目标的意义了。
但是因为避免有时候出现伪目标文件重名的这种情况,我们可以使用一个特殊的标记 .PHONY 来显示地指明一个目标是 伪目标,向 make 说明,不管是否有这个文件,这个目标就是 伪目标。
.PHONY : clean 只要有声明 .PHONY 的话,不管是否存在 clean 文件,只要在命令行执行 make clean,都要运行 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 其中,-$(subst output,,$@) 中的 $ 表示执行一个 Makefile 的函数,函数名为 subst,后面的为参数。关于函数,将在后面讲述。这里的这个函数是截取字符串的意思,$@ 表示目标的集合,就像一个数组,$@ 依次取出目标,并执于命令。
Ⅶ. 静态模式
静态模式可以更加容易地定义多目标的规则,可以让我们的规则变得更加的有弹性和灵活。与其说是静态模式,我更倾向于说成自循环模式!我们还是先来看一下语法:
<targets ...> : <target-pattern> : <prereq-patterns ...>
<commands>
...targets定义了一系列的目标文件,可以有通配符,是目标的一个集合。target-parrtern是指明了targets的模式,也就是的目标集模式。prereq-parrterns是目标的依赖模式,它对target-parrtern形成的模式再进行一次依赖目标的定义。
这样描述这三个东西,可能还是没有说清楚,还是举个例子来说明一下吧。如果我们的 <target-parrtern> 定义成 %.o,意思是我们的 <target> 集合中都是以 .o 结尾的,而如果我们的 <prereq-parrterns> 定义成 %.c,意思是对 <target-parrtern> 所形成的目标集进行二次定义,其计算方法是,取 <target-parrtern> 模式中的 %(也就是去掉了 .o 这个结尾),并为其加上 .c 这个结尾,形成的新集合。
所以,我们的【目标模式】或是【依赖模式】中都应该有 % 这个字符,如果你的文件名中有 % 那么你可以使用反斜杠 \ 进行转义,来标明真实的 % 字符。
看一个例子:
objects = foo.o bar.o
target: $(objects)
$(objects): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@ 上面的例子中,指明了我们的目标从 $object 中获取,%.o 表明所有以 .o 结尾的目标,也就是 foo.o 和 bar.o,这就是变量 $object 集合的模式;
而依赖模式 %.c 则取目标模式 %.o 的 %,也就是 foo 和 bar,并为其加下 .c 的后缀,于是,我们的依赖目标就是foo.c 和 bar.c。
此外命令中的 $< 和 $@ 则是自动化变量,$< 表示所有的依赖目标集(也就是foo.c 和 bar.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 $< $(filter %.o,$(files)) 表示调用 Makefile 的 filter 函数,过滤 $files 集,只要其中模式为 %.o 的内容。其它内容,我就不用多说了吧,这个例子展示了 Makefile 中更大的弹性。
Ⅷ. 自动生成依赖性
这一段本人目前还没看懂,原文也有一些错误,原文的评论区也有很多人在讨论这些错误,我姑且先按原文的意思来,等以后我看懂了再来修改。
在 Makefile 中,我们的依赖关系可能会需要包含一系列的头文件,比如,如果我们的 main.c 中有一句 #include "defs.h",那么我们的依赖关系应该是:
main.o : main.c defs.h 但是,如果是一个比较大型的工程,你必需清楚哪些 C 文件包含了哪些头文件,并且你在加入或删除头文件时,也需要小心地修改 Makefile,这是一个很没有维护性的工作。为了避免这种繁重而又容易出错的事情,我们可以使用 C/C++ 编译的一个功能。大多数的 C/C++ 编译器都支持一个 -M 的选项,即自动找寻源文件中包含的头文件,并生成一个依赖关系。例如,如果我们执行下面的命令:
gcc -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 文件。第二行的意思是,为每个依赖文件 $<,也就是 .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 文件中的目标会成为默认目标。