Makefile 配置和使用

相信作为ARM嵌入式开发人员，对Makefile一定不陌生，但总是容易忘记一些常用语法，所以在这做一些总结，以便快速查找。

1.基础

1.1基础语法

注意，Makefile是严格要求intent使用的是tabs。
即command前为4位tab而不是4个spaces。

1.1.0 Makefile中一些GNU约定俗成的伪目标

伪目标	含义
all	所有目标的目标，其功能一般是编译所有的目标
clean	删除所有被make创建的文件
install	安装已编译好的程序，其实就是把目标可执行文件拷贝到指定的目录中去
print	列出改变过的源文件
tar	把源程序打包备份. 也就是一个tar文件
dist	创建一个压缩文件, 一般是把tar文件压成Z文件. 或是gz文件
TAGS	更新所有的目标, 以备完整地重编译使用
check 或 test	一般用来测试makefile的流程

伪目标并不是一个"目标(target)", 不像真正的目标那样会生成一个目标文件。
典型的伪目标是 Makefile 中用来清理编译过程中中间文件的 clean 伪目标, 一般格式如下:

.PHONY: clean
clean:rm -f *.o

1.1.1依赖原则

依赖关系和生成目标的方法

#格式如下：
target ... : prerequisites ...command
#示例：
all : test.o lib.o font.old -o $@.elf $^objcopy -O binary -S $@.elf $@.bin

command太长, 可以用 “\” 作为换行符.

1.1.2 规则中的通配符

符号	含义
*	表示任意一个或多个字符
？	表示任意一个字符
[…]	ex. [abcd] 表示a,b,c,d中任意一个字符, [^abcd]表示除a,b,c,d以外的字符, [0-9]表示 0~9中任意一个数字
~	表示用户的home目录

1.2变量

1.2.1变量定义（=、 :=、 ?=、 +=）

= 延时变量，只有被使用时才展开定义
:= 立即变量，定义时的赋值立即有效
?= 条件变量，当变量为空时才赋值
+= 追加赋值

1.2.2自动变量

Makefile 中很多时候通过自动变量来简化书写, 各个自动变量的含义如下:

自动变量	含义
$@	目标集合
$%	当目标是函数库文件时, 表示其中的目标文件名
$<	第一个依赖目标. 如果依赖目标是多个, 逐个表示依赖目标
$?	比目标新的依赖目标的集合
$^	所有依赖目标的集合, 会去除重复的依赖目标
$+	所有依赖目标的集合, 不会去除重复的依赖目标
$*	这个是GNU make特有的, 其它的make不一定支持

1.2.3查看C文件的依赖关系

写 Makefile 的时候, 需要确定每个目标的依赖关系.
GNU提供一个机制可以查看C代码文件依赖那些文件, 这样我们在写 Makefile 目标的时候就不用打开C源码来看其依赖那些文件了.

#列出test.c所需的所有依赖
gcc -MM test.c
#将依赖信息写入文件test.d
gcc -M -MF test.d test.c
#编译test.c->test.o并把所需依赖写入test.d
gcc -c -o test.o test.c -MD -MF test.d

1.2.4命令参数变量

变量名	含义
ARFLAGS	AR命令的参数
CFLAGS	C语言编译器的参数
CXXFLAGS	C++语言编译器的参数

2.高级语法

2.1嵌套Makefile

嵌套Makefile，即Makefile里面操作另一个Makefile文件。

示例: (不传递参数, 只是调用子文件夹 other 中的Makefile)

# ./目录下的Makefile 内容
all:@echo "主 Makefile begin"@cd ./other && make@echo "主 Makefile end"# ./other/目录下的Makefile 内容
other-all:@echo "other makefile begin"@echo "other makefile end"

示例: (用export传递参数)

# ./目录下的Makefile 内容
export VALUE1 := export.c    <-- 用了 export, 此变量能够传递到 ./other/Makefile 中
VALUE2 := no-export.c        <-- 此变量不能传递到 ./other/Makefile 中all:@echo "主 Makefile begin"@cd ./other && make@echo "主 Makefile end"# ./other/目录下的Makefile 内容
other-all:@echo "other makefile begin"@echo "VALUE1: " $(VALUE1)@echo "VALUE2: " $(VALUE2)@echo "other makefile end"

补充 export 语法格式如下:
export variable = value
export variable := value
export variable += value

2.2定义命令包

命令包有点像是个函数, 将连续的相同的命令合成一条, 减少 Makefile 中的代码量, 便于以后维护.

#语法:
define <command-name>
command
...
endef
#示例：
define run-hello-makefile
@echo -n "Hello"
@echo " Makefile!"
@echo "这里可以执行多条 Shell 命令!"
endef

2.3条件判断

条件判断的关键字主要有 ifeq ifneq ifdef ifndef

#语法:
<conditional-directive>
<text-if-true>
endif
# 或者
<conditional-directive>
<text-if-true>
else
<text-if-false>
endif#示例: ifeq的例子, ifneq和ifeq的使用方法类似, 就是取反
all:
ifeq ("aa", "bb")@echo "equal"
else@echo "not equal"
endif#示例: ifdef的例子, ifndef和ifdef的使用方法类似, 就是取反
SRCS := program.c
all:
ifdef SRCS@echo $(SRCS)
else@echo "no SRCS"
endif

3.Makefile 中的函数

Makefile 中自带了一些函数, 利用这些函数可以简化 Makefile 的编写.

函数调用语法如下:$(<function> <arguments>)
# 或者
${<function> <arguments>}
<function> 是函数名
<arguments> 是函数参数

3.1字符串函数

3.1.1字符串替换函数: `$(subst <from>,<to>,<text>)`

功能: 把字符串<text> 中的 <from> 替换为 <to>

返回: 替换过的字符串

# Makefile 内容
all:@echo $(subst t,e,maktfilt)  <-- 将t替换为e# bash 中执行 make
$ make
makefile

3.1.2模式字符串替换函数: `$(patsubst <pattern>,<replacement>,<text>)`

功能: 查找<text>中的单词(单词以"空格", “tab”, "换行"来分割) 是否符合 <pattern>, 符合的话, 用 <replacement> 替代.

返回: 替换过的字符串

# Makefile 内容
all:@echo $(patsubst %.c,%.o,programA.c programB.c)# bash 中执行 make
$ make
programA.o programB.o

3.1.3去空格函数: `$(strip <string>)`

功能: 去掉 <string> 字符串中开头和结尾的空字符

返回: 被去掉空格的字符串值

# Makefile 内容
VAL := "       aa  bb  cc "all:@echo "去除空格前: " $(VAL)@echo "去除空格后: " $(strip $(VAL))# bash 中执行 make
$ make
去除空格前:         aa  bb  cc
去除空格后:   aa bb cc

3.1.4查找字符串函数: `$(findstring <find>,<in>)`

功能: 在字符串 <in> 中查找 <find> 字符串

返回: 如果找到, 返回 <find> 字符串, 否则返回空字符串


# Makefile 内容
VAL := "       aa  bb  cc "
all:@echo $(findstring aa,$(VAL))@echo $(findstring ab,$(VAL))# bash 中执行 make
$ make
aa

3.1.5过滤函数: `$(filter <pattern...>,<text>)`

功能: 以 <pattern> 模式过滤字符串 <text>, 保留符合模式 <pattern> 的单词, 可以有多个模式

返回: 符合模式 <pattern> 的字符串

# Makefile 内容
all:@echo $(filter %.o %.a,program.c program.o program.a)
# bash 中执行 make
$ make
program.o program.a

3.1.6反过滤函数: `$(filter-out <pattern...>,<text>)`

功能: 以 <pattern> 模式过滤字符串 <text>, 去除符合模式 <pattern> 的单词, 可以有多个模式

返回: 不符合模式 <pattern> 的字符串

# Makefile 内容
all:@echo $(filter-out %.o %.a,program.c program.o program.a)
# bash 中执行 make
$ make
program.c

3.1.7排序函数: `$(sort <list>)`

功能: 给字符串 <list> 中的单词排序 (升序)

返回: 排序后的字符串

# Makefile 内容
all:@echo $(sort bac abc acb cab)
# bash 中执行 make
$ make
abc acb bac cab

3.1.8取单词函数: `$(word <n>,<text>)`

功能: 取字符串 <text> 中的第<n>个单词 (n从1开始)

返回: <text> 中的第<n>个单词, 如果<n> 比 <text> 中单词个数要大, 则返回空字符串

# Makefile 内容
all:@echo $(word 1,aa bb cc dd)@echo $(word 5,aa bb cc dd)@echo $(word 4,aa bb cc dd)# bash 中执行 make
$ make
aadd

3.1.9取单词串函数: `$(wordlist <s>,<e>,<text>)`

功能: 从字符串<text> 中取从<s>开始到<e>的单词串. <s>和<e>是一个数字.

返回: 从<s>到<e>的字符串

# Makefile 内容
all:@echo $(wordlist 1,3,aa bb cc dd)@echo $(word 5,6,aa bb cc dd)@echo $(word 2,5,aa bb cc dd)# bash 中执行 make
$ make
aa bb ccbb

3.1.10单词个数统计函数: `$(words <text>)`

功能: 统计字符串 <text> 中单词的个数

返回: 单词个数

# Makefile 内容all:@echo $(words aa bb cc dd)@echo $(words aabbccdd)@echo $(words )# bash 中执行 make
$ make
4
1
0

3.1.11首单词函数: `$(firstword <text>)`

功能: 取字符串 <text> 中的第一个单词

返回: 字符串 <text> 中的第一个单词

# Makefile 内容
all:@echo $(firstword aa bb cc dd)@echo $(firstword aabbccdd)@echo $(firstword )# bash 中执行 make
$ make
aa
aabbccdd

3.2文件名函数

3.2.1列出当前目录下符合的文件：`$(wildcard <pattern>)`

功能: 列出当前目录下符合<pattern>的文件

返回: 符合的所有文件名

# Makefile 内容
all:@echo $(wildcard *.c)# bash 中执行 make
$ make
test.c a.c b.c

3.2.2取目录函数: `$(dir <names...>)`

功能: 从文件名序列 <names> 中取出目录部分

返回: 文件名序列 <names> 中的目录部分

# Makefile 内容
all:@echo $(dir /home/a.c ./bb.c ../c.c d.c)# bash 中执行 make
$ make
/home/ ./ ../ ./

3.2.3取文件函数: `$(notdir <names...>)`

功能: 从文件名序列 <names> 中取出非目录部分

返回: 文件名序列 <names> 中的非目录部分

# Makefile 内容
all:@echo $(notdir /home/a.c ./bb.c ../c.c d.c)# bash 中执行 make
$ make
a.c bb.c c.c d.c

3.2.4取后缀函数: `$(suffix <names...>)`

功能: 从文件名序列 <names> 中取出各个文件名的后缀

返回: 文件名序列 <names> 中各个文件名的后缀, 没有后缀则返回空字符串

# Makefile 内容
all:@echo $(suffix /home/a.c ./b.o ../c.a d)# bash 中执行 make
$ make
.c .o .a

3.2.5取前缀函数: `$(basename <names...>)`

功能: 从文件名序列 <names> 中取出各个文件名的前缀

返回: 文件名序列 <names> 中各个文件名的前缀, 没有前缀则返回空字符串

# Makefile 内容
all:@echo $(basename /home/a.c ./b.o ../c.a /home/.d .e)# bash 中执行 make
$ make
/home/a ./b ../c /home/

3.2.6加后缀函数: `$(addsuffix <suffix>,<names...>)`

功能: 把后缀 <suffix> 加到 <names> 中的每个单词后面

返回: 加过后缀的文件名序列

# Makefile 内容
all:@echo $(addsuffix .c,/home/a b ./c.o ../d.c)# bash 中执行 make
$ make
/home/a.c b.c ./c.o.c ../d.c.c

3.2.7加前缀函数: `$(addprefix <prefix>,<names...>)`

功能: 把前缀 <prefix> 加到 <names> 中的每个单词前面

返回: 加过前缀的文件名序列

# Makefile 内容
all:@echo $(addprefix test_,/home/a.c b.c ./d.c)# bash 中执行 make
$ make
test_/home/a.c test_b.c test_./d.c

3.2.8连接函数: `$(join <list1>,<list2>)`

功能: <list2> 中对应的单词加到 <list1> 后面

返回: 连接后的字符串

# Makefile 内容
all:@echo $(join a b c d,1 2 3 4)@echo $(join a b c d,1 2 3 4 5)@echo $(join a b c d e,1 2 3 4)# bash 中执行 make
$ make
a1 b2 c3 d4
a1 b2 c3 d4 5
a1 b2 c3 d4 e

3.3过滤函数

3.3.1取符合要求的`$(filter PATTERN...,TEXT)`

函数功能：过滤掉字串“TEXT”中不符合模式“PATTERN…”的单词，保留所有符合模式的单词，可以使用多个模式，模式中一般需要包含模式字符“%”，存在多个模式时，模式表达式之间使用空格分开。

返回值：空格分割符合模式的字串

示例：

# Makefile 内容
sources := foo.c bar.c baz.s ugh.hfoo: $(sources)cc $(filter %.c %.s, $(sources) ) -o foo$(filter %.c %.s, $(sources) ) 返回值：foo.c bar.c baz.s

3.3.2取不符合要求的`$(filter-out PATTERN...,TEXT)`

示例：略

3.4遍历foreach

语法:

$(foreach <var>,<list>,<text>)

示例:

# Makefile 内容
targets := a b c d
objects := $(foreach i,$(targets),$(i).o)all:@echo $(targets)@echo $(objects)# bash 中执行 make
$ make
a b c d
a.o b.o c.o d.o

3.5判断 if

这里的if是个函数, 和前面的条件判断不一样, 前面的条件判断属于Makefile的关键字

语法:

$(if <condition>,<then-part>)

$(if <condition>,<then-part>,<else-part>)

示例:

# Makefile 内容
val := a
objects := $(if $(val),$(val).o,nothing)
no-objects := $(if $(no-val),$(val).o,nothing)all:@echo $(objects)@echo $(no-objects)# bash 中执行 make
$ make
a.o
nothing

3.6 创建新的参数化函数 call

语法:

$(call <expression>,<parm1>,<parm2>,<parm3>…)

示例:

# Makefile 内容
log = "====debug====" $(1) "====end===="all:@echo $(call log,"正在 Make")# bash 中执行 make
$ make
====debug==== 正在 Make ====end====

3.7判断变量的来源 origin

语法:

$(origin <variable>)

返回值有如下类型:

类型	含义
undefined	<variable> 没有定义过
default	<variable> 是个默认的定义, 比如 CC 变量
environment	<variable> 是个环境变量, 并且 make时没有使用 -e 参数
file	<variable> 定义在Makefile中
command line	<variable> 定义在命令行中
override	<variable> 被 override 重新定义过
automatic	<variable> 是自动化变量

示例:

# Makefile 内容
val-in-file := test-file
override val-override := test-overrideall:@echo $(origin not-define)    # not-define 没有定义@echo $(origin CC)            # CC 是Makefile默认定义的变量@echo $(origin PATH)         # PATH 是 bash 环境变量@echo $(origin val-in-file)    # 此Makefile中定义的变量@echo $(origin val-in-cmd)    # 这个变量会加在 make 的参数中@echo $(origin val-override) # 此Makefile中定义的override变量@echo $(origin @)             # 自动变量, 具体前面的介绍# bash 中执行 make
$ make val-in-cmd=val-cmd
undefined
default
environment
file
command line
override
automatic

3.8 shell

语法:

$(shell <shell command>)

它的作用就是执行一个shell命令, 并将shell命令的结果作为函数的返回.

作用和 `<shell command>` 一样, ` 是反引号

示例

#列出当前目录下文件信息
list=$(shell ls)

3.9 make 控制函数

3.9.1产生一个致命错误: `$(error <text ...>)`

功能: 输出错误信息, 停止Makefile的运行

# Makefile 内容
all:$(error there is an error!)@echo "这里不会执行!"# bash 中执行 make
$ make
Makefile:2: *** there is an error!.  Stop.

3.9.2输出警告: `$(warning <text ...>)`

功能: 输出警告信息, Makefile继续运行

# Makefile 内容
all:$(warning there is an warning!)@echo "这里会执行!"# bash 中执行 make
$ make
Makefile:2: there is an warning!
这里会执行!