Makefile 规则

一个简单的 Makefile 文件包含一系列的“规则”,其样式如下:

1
目标 (target)…: 依赖 (prerequiries)…<tab>命令 (command)
  • 目标 (target) 通常是要生成的文件的名称,可以是可执行文件或 OBJ 文件,也可以是一个执行的动作名称,诸如`clean’。
  • 依赖是用来产生目标的材料(比如源文件),一个目标经常有几个依赖。
  • 命令是生成目标时执行的动作,一个规则可以含有几个命令,每个命令占一行。 注意:每个命令行前面必须是一个 Tab 字符,即命令行第一个字符是 Tab。

通常,如果一个依赖发生了变化,就需要规则调用命令以更新或创建目标。但是并非所有的目标都有依赖,例如,目标“clern”的作用是清除文件,它没有依赖。 规则一般是用于解释怎样和何时重建目标。

make 首先调用命令处理依赖,进而才能创建或更新目标。当然,一个规则也可以是用于解释怎样和何时执行一个动作,即打印提示信息。一个 Makefile 文件可以包含规则以外的其他文本,但一个简单的 Makefile 文件仅仅需要包含规则。虽然真正的规则比这里展示的例子复杂,但格式是完全一样的。

对于上面的 Makefile,执行“make”命令时,仅当 hello.c 文件比 hello 文件新时才会执行命令“arm-linux-gcc –o hello hello.c”生成可执行文件 hello;如果还没有 hello 文件,这个命令也会执行。 运行“make clean”时,由于目标 clean 没有依赖,它的命令“rm -f hello”将被强制执行。

变量

即时变量、延时变量

变量的定义语法形式如下:

1
2
3
4
5
A  =  xxx    // 延时变量,它的值在使用时才展开、才确定
B ?= xxx // 延时变量,只有第一次定义时赋值才成功;如果曾定义过,此赋值无效
C := xxx // 立即变量
D += yyy // 如果 D 在前面是延时变量,那么现在它还是延时变量;
// 如果 D 在前面是立即变量,那么现在它还是立即变量

变量的导出 (export)

在编译程序时,我们会不断地使用“make -C dir”切换到其他目录,执行其他目录里的 Makefile。如果想让某个变量的值在所有目录中都可见,要把它 export 出来。 比如“CC = $(CROSS_COMPILE)gcc”,这个 CC 变量表示编译器,在整个过程中都是一样的。定义它之后,要使用“export CC”把它导出来。

Makefile 中可以使用 shell 命令

比如:

1
TOPDIR := $(shell pwd)

这是个立即变量,TOPDIR 等于 shell 命令 pwd 的结果。

Makefile 文件里的赋值方法

变量的定义语法形式如下:

1
2
3
4
5
immediate = deferred
immediate ?= deferred
immediate := immediate
immediate += deferred or immediatedefine
immediatedeferredendef

在 GNU make 中对变量的赋值有两种方式:延时变量、立即变量。区别在于它们的定义方式和扩展时的方式不同,前者在这个变量使用时才扩展开,意即当真正使用时这个变量的值才确定;后者在定义时它的值就已经确定了。使用=, ?=定义或使用 define 指令定义的变量是延时变量;使用:=定义的变量是立即变量。需要注意的一点是,?=仅仅在变量还没有定义的情况下有效,即?=被用来定义第一次出现的延时变量。 对于附加操作符+=,右边变量如果在前面使用(:=)定义为立即变量则它也是立即变量,否则均为延时变量。

目标

在 Makefile 中怎么放置第 1 个目标

执行 make 命令时如果不指定目标,那么它默认是去生成第 1 个目标。 所以“第 1 个目标”,位置很重要。有时候不太方便把第 1 个目标完整地放在文件前面,这时可以在文件的前面直接放置目标,在后面再完善它的依赖与命令。比如:

1
2
3
4
First_target:   // 这句话放在前面....  
// 其他代码,比如 include 其他文件得到后面的 xxx 变量
First_target : $(xxx) $(yyy) // 在文件的后面再来完善
command

假想目标

我们的 Makefile 中有这样的目标:

1
clean:    rm -f $(shell find -name "*.o")    rm -f $(TARGET)

如果当前目录下恰好有名为“clean”的文件,那么执行“make clean”时它就不会执行那些删除命令。 这时我们需要把“clean”这个目标,设置为“假想目标”,这样可以确保执行“make clean”时那些删除命令肯定可以得到执行。 使用下面的语句把“clean”设置为假想目标:

1
.PHONY : clean

Makefile 常用函数

字符串替换和分析函数

$(subst from,to,text)

在文本 text 中使用 to 替换每一处`from’。 eg:

1
$(subst ee,EE,feet on the street) #结果为‘fEEt on the street’

$(patsubst pattern,replacement,text)

寻找 text’中符合格式 pattern’的字,用 replacement’替换它们。pattern’和 replacement’中可以使用通配符。 eg:

1
bash $(patsubst %.c,%.o,x.c.c bar.c) #结果为:x.c.o bar.o

$(strip string)

去掉前导和结尾空格,并将中间的多个空格压缩为单个空格。 eg:

1
$(strip a   b c ) #结果为`a b c’

$(findstring find,in)

在字符串 in 中搜寻 find,如果找到,则返回值是`find’,否则返回值为空。 eg:

1
$(findstring a,a b c) #产生 a$(findstring a,b c)   #产生空

$(filter pattern…,text)

返回在 text’中由空格隔开且匹配格式 pattern…’的字,去除不符合格式 pattern...’的字。 eg: bash $(filter %.c %.s, foo.c bar.c baz.s ugh.h) #结果为 foo.c bar.c baz.s’

$(filter-out pattern…,text)

返回在 text’中由空格隔开且不匹配格式 pattern…’的字,去除符合格式 pattern...’的字。它是函数 filter 的反函数。 eg:

1
$(filter %.c %.s,foo.c bar.c baz.s ugh.h) #结果为 ugh.h 

$(sort list)

将‘list’中的字按字母顺序排序,并去掉重复的字。输出由单个空格隔开的字的列表。 eg:

1
$(sort foo bar lose) # 返回值是‘bar foo lose’

文件名函数

$(dir names…)

抽取‘names…’中每一个文件名的路径部分,文件名的路径部分包括从文件名的首字符到最后一个斜杠(含斜杠)之前的一切字符。 eg:

1
$(dir src/foo.c hacks) # 结果为‘src/ ./’

$(notdir names…)

抽取‘names…’中每一个文件名中除路径部分外一切字符(真正的文件名)。 eg:

1
$(notdir src/foo.c hacks) #结果为‘foo.c hacks’

$(suffix names…)

抽取‘names…’中每一个文件名的后缀。 eg:

1
$(suffix src/foo.c src-1.0/bar.c hacks) # 结果为‘.c .c’

$(basename names…)

抽取‘names…’中每一个文件名中除后缀外一切字符。 eg:

1
$(basename src/foo.c src-1.0/bar hacks) #结果为‘src/foo src-1.0/bar hacks’

$(addsuffix suffix,names…)

参数‘names…’是一系列的文件名,文件名之间用空格隔开;suffix 是一个后缀名。将 suffix(后缀)的值附加在每一个独立文件名的后面,完成后将文件名串联起来,它们之间用单个空格隔开。 eg:

1
$(addsuffix .c,foo bar) # 结果为‘foo.c bar.c’

$(addprefix prefix,names…)

参数‘names’是一系列的文件名,文件名之间用空格隔开;prefix 是一个前缀名。将 preffix(前缀)的值附加在每一个独立文件名的前面,完成后将文件名串联起来,它们之间用单个空格隔开。 eg:

1
$(addprefix src/,foo bar) # 结果为‘src/foo src/bar’

$(wildcard pattern)

参数‘pattern’是一个文件名格式,包含有通配符(通配符和 shell 中的用法一样)。函数 wildcard 的结果是一列和格式匹配的且真实存在的文件的名称,文件名之间用一个空格隔开。 eg: 若当前目录下有文件 1.c、2.c、1.h、2.h,则:

1
c_src := $(wildcard *.c) #结果为‘1.c 2.c’

其他函数

$(foreach var,list,text)

简单地说,就是 for each var in list, change it to text。对 list 中的每一个元素,取出来赋给 var,然后把 var 改为 text 所描述的形式。 eg:

1
objs := a.o b.odep_files := $(foreach  f,  $(objs),  .$(f).d)  // 最终 dep_files := .a.o.d .b.o.d

$(if condition,then-part[,else-part])

先把第一个参数‘condition’的前导空格、结尾空格去掉,然后扩展。如果扩展为非空字符串,则条件‘condition’为‘真’;如果扩展为空字符串,则条件‘condition’为‘假’。 如果条件‘condition’为‘真’, 那么计算第二个参数‘then-part’的值,并将该值作为整个函数 if 的值。 如果条件‘condition’为‘假’, 并且第三个参数存在,则计算第三个参数‘else-part’的值,并将该值作为整个函数 if 的值;如果第三个参数不存在,函数 if 将什么也不计算,返回空值。

(originvariable)

变量‘variable’是一个查询变量的名称_,不是对该变量的引用。所以不能采用‘’和圆括号的格式书写该变量,当然,如果需要使用非常量的文件名,可以在文件名中使用变量引用。

函数 origin 的结果是一个字符串,该字符串变量是这样定义的:

1
2
3
4
5
6
7
8
'undefined'             :如果变量‘variable’从没有定义;
‘default' :变量‘variable’是缺省定义;
‘environment' :变量‘variable’作为环境变量定义,选项‘-e’没有打开;
‘environment override' :变量‘variable’作为环境变量定义,选项‘-e’已打开;
‘file' :变量‘variable’在 Makefile 中定义;
‘command line' :变量‘variable’在命令行中定义;
override' :变量‘variable’在 Makefile 中用 override 指令定义;
‘automatic' :变量‘variable’是自动变量

$(shell command arguments)

函数 shell 是 make 与外部环境的通讯工具。函数 shell 的执行结果和在控制台上执行‘command arguments’的结果相似。不过如果‘command arguments’的结果含有换行符(和回车符),则在函数 shell 的返回结果中将把它们处理为单个空格,若返回结果最后是换行符(和回车符)则被去掉。 比如当前目录下有文件 1.c、2.c、1.h、2.h,则:

1
c_src := $(shell ls *.c) # 结果为‘1.c 2.c’

make 命令的使用

执行 make 命令时,它会去当前目录下查找名为“Makefile”的文件,并根据它的指示去执行操作,生成第一个目标。 我们可以使用“-f”选项指定文件,不再使用名为“Makefile”的文件,比如:

1
make  -f  Makefile.build 

我们可以使用“-C”选项指定目录,切换到其他目录里去,比如:

1
make -C  a/  -f  Makefile.build

我们可以指定目标,不再默认生成第一个目标:

1
make -C  a/  -f  Makefile.build   other_target

参考文献

《韦东山老师的课程及书籍》