Makefile基础教程.docx
《Makefile基础教程.docx》由会员分享,可在线阅读,更多相关《Makefile基础教程.docx(18页珍藏版)》请在冰豆网上搜索。
Makefile基础教程
Makefile基础教程
Make程序最初设计是为了维护C程序文件防止不必要的重新编译。
在使用命令行编译器的时候,修改了一个工程中的头文件,如何确保包含这个头文件的所有文件都得到编译?
现在10机的版本生成是使用批处理程序,编译那些文件依赖于程序的维护者,在模块之间相互引用头文件的情况下,要将所有需要重新编译的文件找出来是一件痛苦的事情;在找到这些文件之后,修改批处理进行编译。
实际上这些工作可以让make程序来自动完成,make工具对于维护一些具有相互依赖关系的文件特别有用,它对文件和命令的联系(在文件改变时调用来更新其它文件的程序)提供一套编码方法。
Make工具的基本概念类似于Proglog语言,你告诉make需要做什么,提供一些规则,make来完成剩下的工作。
1简介
make工作自动确定工程的哪部分需要重新编译,执行命令去编译它们。
虽然make多用于C程序,然而只要提供命令行的编译器,你可以将其用于任何语言。
实际上,make工具的应用范围不仅于编程,你可以描述任和一些文件改变需要自动更新另一些文件的任务来使用它。
1.1准备工作
如果要使用make,你必须写一个叫做“makefile”的文件,这个文件描述工程中文件之间的关系,提供更新每个文件的命令。
典型的工程是这样的:
可执行文件靠目标文件来更新,目标文件靠编译源文件来更新。
Makefile写好之后,每次更改了源文件后,只要执行make就足够了,所有必要的重新编译将执行。
Make程序利用makefile中的数据库和文件的最后修改时间来确定那个文件需要更新;对于需要更新的文件,make执行数据库中记录的命令。
可以提供命令行参数给make来控制那个文件需要重新编译。
1.2Makefile介绍
Makefile文件告诉make做什么,多数情况是怎样编译和链接一个程序。
这里有一个简单的makefile,描述如何编译链接由8个C文件和3个头文件组成的一个编辑器:
edit:
main.okbd.ocommand.odisplay.o\
insert.oserach.ofiles.outils.o
cc–oeditmain.okbd.ocommand.odisplay.o\
insert.osearch.ofiles.outils.o
main.o:
main.cdefs.h
cc–cmain.c
kdb.o:
kbd.cdefs.hcommand.h
cc–ckbd.c
command.o:
command.cdefs.hcommand.h
cc-ccommand.c
display.o:
display.cdefs.hbuffer.h
cc-cdisplay.c
insert.o:
insert.cdefs.hbuffer.h
cc-cinsert.c
search.o:
search.cdefs.hbuffer.h
cc-csearch.c
files.o:
files.cdefs.hbuffer.hcommand.h
cc-cfiles.c
utils.o:
utils.cdefs.h
cc-cutils.c
clean:
rmeditmain.okbd.ocommand.odisplay.o\
insert.osearch.ofiles.outils.o
将长行用\分开便于阅读,这和使用一个长行的作用是一样的。
使用这个makefile创建可执行文件“edit”时运行make就可以了;如果要将可执行文件和目标文件删除,执行makeclean
make重新编译这个编辑器时,每个更改的C文件必须重新编译;如果头文件更改了,每个包含头文件的C文件必须重新编译;每次编译产生一个对应于原文件的目标文件。
最终,目标文件链接在一起产生新的可执行文件。
1.3规则简介
makefile中的规则是这样的:
TARGET… :
DEPENDENCIES…
COMMAND
…
目标(TARGET)程序产生的文件,如可执行文件和目标文件;目标也可以是要执行的动作,如“clean”。
依赖(DEPENDENCIES)是用来产生目标的输入文件,一个目标通常依赖于多个文件。
命令(COMMAND)是make执行的动作,一个可以有多个命令,每个占一行。
注意:
每个命令行的起始字符必须为TAB字符!
有依赖关系规则中的命令通常在依赖文件变化时负责产生target文件,make执行这些命令更新或产生target。
规则可以没有依赖关系,如包含target“clean”的规则。
规则解释如何和何时重做该规则中的文件,make根据依赖关系执行产生或更新目标;规则也说明如何和何时执行动作。
有的规则看起来很复杂,但都符合上述模式。
1.4make工作原理
缺省make从第一个target开始(第一个非’.’开始的target),这称作缺省目标。
在上述的makefile中,缺省目标是更新执行程序’edit’,将这个目标置于最前面。
当执行make的时候,make程序从当前目录读入makefile开始处理第一个规则;在例子中,这个规则是重新链接’edit’;在make处理这个规则之前,必须处理’edit’所依赖的那些文件的规则,例子中是目标文件。
这些文件按照他们自己的规则处理:
通过编译源文件来更新每个’.o’文件;当依赖关系中的源文件或头文件比目标文件新,或目标文件不存在时,必须重新编译。
其它的规则被处理是因为他们的target是目标的依赖,和目标没有依赖关系的规则不会被处理,除非指定make处理(如makeclean)。
在重新编译目标文件之前,make会试图更新它的依赖:
源文件和头文件。
例子中的makefile对源文件和头文件未指定任何操作:
’.c’和’.h’文件不是任何规则的目标。
确认所有的目标文件都是最新的之后,make决定是否重新链接’edit’:
如果’edit’不存在,或者任何一个目标文件都比它新,则链接工作将进行。
这样,如果我们改变insert.c运行make,make会编译这个文件来更新’insert.o’,然后链接’edit’;如果修改了’command.h’运行make,’kbd.o’,’command.o’,’files.o’会重新生成,链接’edit’。
1.5使用变量
在例子中,在规则’edit’中,目标文件被列出来两次:
edit:
main.okbd.ocommand.odisplay.o\
insert.osearch.ofiles.outils.o
cc-oeditmain.okbd.ocommand.odisplay.o\
insert.osearch.ofiles.outils.o
这样的重复容易出错:
假设工程中加入了一个新的目标文件,可能只将其加入了一个列表中;通过使用变量可以消除这种风险:
变量允许一个预定义的字符串在多个地方被替换。
在makefile中,可以写这样一行来定义’object’变量:
objects=main.okbd.ocommand.odisplay.o\
insert.osearch.ofiles.outils.o
于是在需要目标文件名列表的地方,使用$(object)来代替变量的值。
以下是使用了变量以后的makefile:
objects=main.okbd.ocommand.odisplay.o\
insert.osearch.ofiles.outils.o
edit:
$(objects)
cc-oedit$(objects)
main.o:
main.cdefs.h
cc-cmain.c
kbd.o:
kbd.cdefs.hcommand.h
cc-ckbd.c
command.o:
command.cdefs.hcommand.h
cc-ccommand.c
display.o:
display.cdefs.hbuffer.h
cc-cdisplay.c
insert.o:
insert.cdefs.hbuffer.h
cc-cinsert.c
search.o:
search.cdefs.hbuffer.h
cc-csearch.c
files.o:
files.cdefs.hbuffer.hcommand.h
cc-cfiles.c
utils.o:
utils.cdefs.h
cc-cutils.c
clean:
rmedit$(objects)
1.6简化命令
为每个文件写出编译命令不是必要的,因为make可以自己来做;以’.c’文件更新’.o’文件有一个隐含的规则,使用’cc-c’命令。
Make将利用’cc–cmain.c–omain.o’来将main.c编译为main.o,因此在生成目标文件的规则中,可以省略命令。
当’.c’文件以这样的方式使用时,将自动加入到依赖关系中;由是在省略命令的前提下,可以将’.c’文件从依赖关系中省略。
以下是简化过的makefile:
objects=main.okbd.ocommand.odisplay.o\
insert.osearch.ofiles.outils.o
edit:
$(objects)
cc-oedit$(objects)
main.o:
defs.h
kbd.o:
defs.hcommand.h
command.o:
defs.hcommand.h
display.o:
defs.hbuffer.h
insert.o:
defs.hbuffer.h
search.o:
defs.hbuffer.h
files.o:
defs.hbuffer.hcommand.h
utils.o:
defs.h
.PHONY:
clean
clean:
-rmedit$(objects)
1.7另一种风格
如果makefile中的目标都是以隐含规则生成,可以将规则按照依赖关系分组:
objects=main.okbd.ocommand.odisplay.o\
insert.osearch.ofiles.outils.o
edit:
$(objects)
cc-oedit$(objects)
$(objects):
defs.h
kbd.ocommand.ofiles.o:
command.h
display.oinsert.osearch.ofiles.o:
buffer.h
这里’defs.h’作为所有目标文件的依赖。
这种风格是好是坏取决于个人喜好,它非常紧凑,但是将每个目标的依赖信息放在一起看起来更清楚一些。
1.8清理
编写规则不至于编译程序。
Makefile通常描述如何做其它事情:
比如删除目录中的目标文件和可执行文件来清理目录。
例子中是这样写的:
clean:
rmedit$(objects)
实际情况是,我们需要处理一些意外事件:
存在一个叫做’clean’的文件;如果rm出错,并不希望make过程停止下来,修改过的版本如下:
.PHONY:
clean
clean:
-rmedit$(objects)
这样的规则当然不能放在makefile的开始,因为这并不是我们缺省要做的工作。
由于’clean’并不是’edit’的依赖,在运行make时没有参数时,这条规则不会执行;要执行这个规则,必须运行’makeclean’。
2Makefile
Makefile中包含五种内容:
显式规则,隐式规则,变量定义,指令(directive)和注释。
;显式规则描述如何生成规则的目标,它列出了目标依赖的文件,指定了产生或更新目标的命令
;隐式规则描述如何生成基于文件名的一类文件,说明目标可能依赖于和其文件名类似的文件,指定了相应的命令。
;指令类似与编译器的伪指令,包含:
;指示make读入另一个makefile
;决定是否忽略makefile中的一部分
;定义一个变量
;一行中‘#’开始是注释,直到行末,除非遇到续行符号。
在’define’和命令中不能有注释,其它情况下注释可出现在任何地方。
2.1makefile名字
缺省情况下,make以下列名字查找makefile:
’GNUmakefile’,’makefile’和’Makefile’(注意大小写)。
通常你的makefile应叫做’makefile’或’Makefile’。
’GNUmakefile’不推荐,除非你的makefile是为GNU的make定制的,其它的make不认为该名字是一个makefile的名字。
如果你使用非标准命名的makefile,必须用命令开关’-f’或’—file’。
参数’–fNAME’或’—fileNAME’告诉make读入NAME作为makefile。
如果使用多个该开关,所有的文件将按顺序连接起来。
如果使用该选项,标准的makefile名字不会自动检测。
2.2包含
‘include’指令告诉make暂停处理余下的内容,读入其它makefile。
语法如下:
includeFILENAMES…
这一行起始可以有空格,但TAB字符不允许。
如果文件名包含变量或函数,这些将被扩展。
2.3‘MAKEFILE’变量
如果环境变量’MAKEFILE’已定义,make认为它的值是一系列空格隔开的文件名,这些文件在处理其它makefile前被make程序读入。
这类似于include指令;这些文件中的目标不会影响缺省目标,而且如果文件未找到的话,make并不认为是错误。
这个变量的主要用途是递归引用make程序时通讯
2.4如何重新生成makefile
有时候makefile是从其它文件生成的,比如RCS或SCCS文件。
如果makefile是由其它文件生成的,需要make读入最新版本的makefile。
在读入所有makefile之后,make认为每个makefile是一个目标,试图去更新它;如果makefile中有一条如何更新它的规则,或者有适用的隐式规则,需要的更新会进行。
所有的makefile检查完之后,如果有的改变了,make重新开始再读入(make会试图再做更新,但通常不会再改变了,因为已经是最新的了)。
如果一个文件使用双冒号规则,提供了命令但没有依赖关系,文件始终会被更新。
在makefile的情况下,如果makefile双冒号规则,提供了命令但没有依赖关系,这样makefile始终会重新生成,这会导致循环:
make只是在不断更新makefile,却不干活。
为避免这种情况,make不会重新生成那些只有命令没有依赖关系的双冒号规则的makefile。
如果没有使用’-f’或’--file’选项,make会尝试缺省的makefile文件名。
和指明’-f’或’--file’选项不同,make不能确定这些文件是否应当存在。
然而,如果缺省makefile不存在但可以通过运行make规则生成,你可能希望这些规则被运行使得makefile可以使用。
因此,如果没有缺省makefile,make试图按照makefile名查找的顺序生成它,直到成功或名字用完。
注意如果make不能找到或生成makefile,这并不是错误;makefile不总是必需的。
当使用’-t’或’--touch’选项时,不希望使用过时的makefile来决定那个目标来touch。
所以’-t’选项对makefile更新不起作用;类似’-q’(or‘—question’)和’-n’(or’—just-print’)不阻止makefile的更新,因为过时的makefile会产生错误的输出。
这样’make–fmfile–nfoo’会更新’mfile’,读入它,打印出更新’foo’需要执行的命令但不运行这些命令。
与’foo’有关的命令是更新过的’mfile’中的内容。
但是有时不希望更新makefile,可以将makefile作为命令行的目标,当makefile被显式指定为目标时,’-t’选项也适用于它们。
这样’make–fmfile–nmfilefoo’会读入’mfile’,打印出更新执行的命令,’foo’的命令是当前的’mfile’中的内容。
2.5重载makefile
可以使用’include’指令来包含其它makefile,增加目标的变量定义。
然而,make不允许同一个目标有不同的命令,有其它的途径可以达到目的。
假设有’makefile’和’mfile’,’makfile’要包含’mfile’,但都有对于目标’foo’的规则。
这是可以在’makefile’中写一条匹配任意模式的规则,指明当make在’makefile’中未找到目标时,搜索’mfile’:
foo:
frobnicate>;foo
%:
force
@$(MAKE)-fmfile$@
force:
;
当执行’makefoo’时,make找到’makefile’,执行命令’frobnicate>;foo’;执行’makebar’时,在’makefile’中未找到相应的规则,这时模式规则适用,执行命令’make–fmfilebar’,’makefile’中未提及的其它目标也是类似的。
这种方法之所有工作是因为模式规则的模式是’%’,可以匹配任何的目标;这条规则的依赖是’force’,保证即使目标存在命令也会执行;’force’规则的命令为空防止’make’为其搜索隐式规则-这样会导致依赖循环。
3规则
makefile中的规则描述如何生成特定的文件,即规则的目标。
规则列出了目标的依赖文件,指定生成或更新目标的命令。
规则的次序是不重要的,除非是确定缺省目标:
缺省目标是第一个makefile中的第一个规则;如果第一个规则有多个目标,第一个目标是缺省的。
有两个例外:
以’.’开头的目标不是缺省目标;模式规则对缺省目标没有影响。
通常我们所写的地一个规则是编译整个或makefile中指定的所有程序。
3.1例子
foo.o:
foo.cdefs.h #modulefortwiddlingthefrobs
cc-c-gfoo.c
它的目标是’foo.o’,依赖于’foo.c’和’defs.h’,有一个命令’cc–c–gfoo.c’。
命令行以TAB字符开始标识它是一个命令。
这条规则说明两件事:
;如何决定’foo.o’是旧的:
如果它不存在,或者’foo.c’或者’defs.h’比它新。
;如何更新’foo.o’文件:
通过运行’cc’程序。
命令未提及’defs.h’,担可以猜想’foo.c’包含了它,这是’defs.h’被置于依赖关系中的理由。
3.2规则的语法
语法如下:
TARGETS:
DEPENDENCIES
COMMAND
...
或者
TARGETS:
DEPENDENCIES;COMMAND
COMMAND
...
TARGETS是以空格隔开的文件名,统配符可以使用。
通常一个规则只有一个目标,偶尔也有多个。
命令行以TAB键开始。
第一条命令可在依赖关系的下一行;或者在同一行,在分号后面;两种方式效果相同。
因为’$’符号被用做变量引用,如果要在规则中使用’$’符号,必须写两个:
’$$’。
可以用’\’符号来分割一个长行,这不是必须的,因为make对行的长度没有限制。
3.3通配符
规则中的文件名可以包含统配符,如’*’,’?
’。
文件名前的字符’~’有特殊的含义。
单独使用,或跟随一个’/’,代表用户的home目录,比如’~/bin’扩展为/home/you/bin’;如果’~’跟随一个单词,表示单词指示的那个用户的home目录,如’~john/bin’扩展为’/home/john/bin’。
通配符在目标,依赖关系,命令中自动扩展,其它情况下,统配符的扩展除非显式使用’wildcard’函数。
通配符的特殊意义可以使用’\’符号关闭。
例子:
clean:
rm-f*.o
和
print:
*.c
lpr-p$?
touchprint
通配符在定义变量时并不扩展,例如:
objects=*.o
则objects的值是字符串’*.o’;但是如果你将objects用于目标,依赖或命令中,扩展会进行。
要将objects设置成扩展过的内容,使用:
objects:
=$(wildcard*.o)
3.3.1通配符的缺陷
这是一个使用通配符的例子,但结果不是你所期望的。
假设可执行文件’foo’是从当前目录中的所有’.o’文件生成的:
objects=*.o
foo:
$(objects)
cc-ofoo$(CFLAGS)$(objects)
objects变量的值是字符串’*.o’。
通配符扩展在规则’foo’中进行,于是所有存在的’.o’文件成为’foo’的依赖而且在需要时重新编译。
但如果删除了所有的’.o’文件呢?
当通配符不匹配任何文件时,一切都保持原样:
则’foo’依赖于一个叫做’*.o’的文件;由于这个文件不大可能存在,’make’程序会报告一个无法生成’*.o’文件的错误,这不是期待的结果。
实际上可以用通配符获得期望结果,但是需要复杂的技术,包括’wildcard’函数和字符串替换函数。
3.3.2wildcard函数
通配符自动在规则中进行。
但是在变量赋值的和函数的参数中通配符不会扩展,如果在这些情况下需要通配符扩展,必须使用’wildcard’函数。
语法如下:
$(wildcardPATTERN...)
这个在makefile任何地方出现的字符串,会被匹配任何一个文件名格式的以空格隔开的现有文件列表替换。
如果没有任何文件匹配一个模式,这个模式从’wildcard’的输出中忽略,注意,这和上述的通配符的处理是不一样的。
‘wildcard’函数的一个功能是找出目录中所有的’.c’文件:
$(wildcard*.c)
可以通过替换后缀’.c’为’.o’从C文件列表得到目标文件的列表:
$(patsubst%.c,%.o,$(wildcard*.c))
这样,上节中的makefile改写为:
objects:
=$(patsubst%.c,%.o,$(wildcard*.c))
foo:
$(objects)
cc-ofoo$(objects)
这个makefile利用了编译C程序的隐含规则,所以不需要对编译写出显式的规