Linux/Unix环境下的make和makefile
介绍一下make及其描述文件makefile
Makefile文件
Make工具最主要也是最基本的功能就是通过makefile文件来描述源程序之间
的相互关系并自动维护编译工作。而makefile 文件需要按照某种语法进行编写，文件
中需要说明如何编译各个源文件并连接生成可执行文件，并要求定义源文件之间的依赖
关系。
在 UNIX 系统中，习惯使用 Makefile 作为 makfile 文件。如果要使用其
他文件作为 makefile，则可利用类似下面的 make 命令选项指定 makefile 文件：
$ make -f test.mk
Makefile文件作为一种描述文档一般需要包含以下内容:
◆ 宏定义
◆ 源文件之间的相互依赖关系
◆ 可执行的命令
Makefile中允许使用简单的宏指代源文件及其相关编译信息，在Linux中也
称宏为变量。在引用宏时只需在变量前加$符号，但值得注意的是，如果变量名的长度
超过一个字符，在引用时就必须加圆括号（）。
下面都是有效的宏引用：
$(TAG)
$2
$Z
$(Z)
其中最后两个引用是完全一致的。
Make命本身可带有四种参数：标志、宏定义、描述文件名和目标文件名。其
标准形式为：
Make [flags] [macro definitions] [targets]
Unix系统下标志位flags选项及其含义为：
-f file 指定file文件为描述文件，如果file参数为"-"符，那么描述文
件指向标准输入。如果没有"-f"参数，则系统将默认当前目录下名为makefile或者名为
Makefile的文件为描述文件。在Linux中， GNU make 工具在当前工作目录中按照
GNUmakefile、makefile、Makefile的顺序搜索 makefile文件。
-i 忽略命令执行返回的出错信息。
-s 沉默模式，在执行之前不输出相应的命令行信息。
-r 禁止使用build-in规则。
-n 非执行模式，输出所有执行命令，但并不执行。不执行参数，这些参数只是打印命令，不管目标是否更新，把规则和连带规则下的命令打印出来，但不执行，这些参数对于我们调试makefile很有用处。
-t 更新目标文件。
-q make操作将根据目标文件是否已经更新返回"0"或非"0"的状态信
息。
-p 输出所有宏定义和目标文件描述。
-d Debug模式，输出有关文件和检测时间的详细信息。
Linux下make标志位的常用选项与Unix系统中稍有不同，下面我们只列出了
不同部分：
-c dir 在读取 makefile 之前改变到指定的目录dir。
-I dir 当包含其他 makefile文件时，利用该选项指定搜索目录。
-h help文挡，显示所有的make选项。
-w 在处理 makefile 之前和之后，都显示工作目录。
通过命令行参数中的target ，可指定make要编译的目标，并且允许同时定
义编译多个目标，操作时按照从左向右的顺序依次编译target选项中指定的目标文件。
如果命令行中没有指定目标，则系统默认target指向描述文件中第一个目标文件。
通常，makefile 中还定义有 clean 目标，可用来清除编译过程中的中间文
件，例如：
clean:
rm -f *.o
运行 make clean 时，将执行 rm -f *.o 命令，最终删除所有编译过程中
产生的所有中间文件。
1 规则中的通配符
- * :: 表示任意一个或多个字符
- ? :: 表示任意一个字符
- [...] :: ex. [abcd] 表示a,b,c,d中任意一个字符, [^abcd]表示除a,b,c,d以外的字符, [0-9]表示 0~9中任意一个数字
- ~ :: 表示用户的home目录
2 Makefile中的变量
2.1 变量的定义(= or :=)
OBJS = true OBJS-ADD = $(OBJS) # 或者 OBJS := true OBJS-ADD := $(OBJS)其中 = 和 := 的区别在于, := 只能使用前面定义好的变量, = 可以使用后面定义的变量
# Makefile内容
OBJS2 = $(OBJS1) programC.o
OBJS1 = programA.o programB.o
all:
@echo $(OBJS2)
# bash中执行 make, 可以看出虽然 OBJS1 是在 OBJS2 之后定义的, 但在 OBJS2中可以提前使用
$ make
programA.o programB.o programC.o
# Makefile内容
OBJS2 := $(OBJS1) programC.o
OBJS1 := programA.o programB.o
all:
@echo $(OBJS2)
# bash中执行 make, 可以看出 OBJS2 中的 $(OBJS1) 为空
$ make
programC.o
2.2变量的替换
# Makefile内容
SRCS := programA.c programB.c programC.c
OBJS := $(SRCS:%.c=%.o)
all:
@echo "SRCS: " $(SRCS)
@echo "OBJS: " $(OBJS)
# bash中运行make
$ make
SRCS: programA.c programB.c programC.c
OBJS: programA.o programB.o programC.o
2.3变量追加值
# Makefile内容
SRCS := programA.c programB.c programC.c
SRCS += programD.c
all:
@echo "SRCS: " $(SRCS)
# bash中运行make
$ make
SRCS: programA.c programB.c programC.c programD.c
2.4变量覆盖
作用是使 Makefile中定义的变量能够覆盖 make 命令参数中指定的变量
语法:
- override <variable> = <value>
- override <variable> := <value>
- override <variable> += <value>
# Makefile内容 (没有用override)
SRCS := programA.c programB.c programC.c
all:
@echo "SRCS: " $(SRCS)
# bash中运行make
$ make SRCS=nothing
SRCS: nothing
#################################################
# Makefile内容 (用override)
override SRCS := programA.c programB.c programC.c
all:
@echo "SRCS: " $(SRCS)
# bash中运行make
$ make SRCS=nothing
SRCS: programA.c programB.c programC.c
2.5 Makefile命令前缀
Makefile 中书写shell命令时可以加2种前缀 @ 和 -, 或者不用前缀.
3种格式的shell命令区别如下:
- 不用前缀 :: 输出执行的命令以及命令执行的结果, 出错的话停止执行
- 前缀 @ :: 只输出命令执行的结果, 出错的话停止执行
- 前缀 - :: 命令执行有错的话, 忽略错误, 继续执行
# Makefile 内容 (不用前缀)
all:
echo "没有前缀"
cat this_file_not_exist
echo "错误之后的命令" <-- 这条命令不会被执行
# bash中执行 make
$ make
echo "没有前缀" <-- 命令本身显示出来
没有前缀 <-- 命令执行结果显示出来
cat this_file_not_exist
cat: this_file_not_exist: No such file or directory
make: *** [all] Error 1
###########################################################
# Makefile 内容 (前缀 @)
all:
@echo "没有前缀"
@cat this_file_not_exist
@echo "错误之后的命令" <-- 这条命令不会被执行
# bash中执行 make
$ make
没有前缀 <-- 只有命令执行的结果, 不显示命令本身
cat: this_file_not_exist: No such file or directory
make: *** [all] Error 1
###########################################################
# Makefile 内容 (前缀 -)
all:
-echo "没有前缀"
-cat this_file_not_exist
-echo "错误之后的命令" <-- 这条命令会被执行
# bash中执行 make
$ make
echo "没有前缀" <-- 命令本身显示出来
没有前缀 <-- 命令执行结果显示出来
cat this_file_not_exist
cat: this_file_not_exist: No such file or directory
make: [all] Error 1 (ignored)
echo "错误之后的命令" <-- 出错之后的命令也会显示
错误之后的命令 <-- 出错之后的命令也会执行
2.6 伪目标
伪目标并不是一个"目标(target)", 不像真正的目标那样会生成一个目标文件.
典型的伪目标是 Makefile 中用来清理编译过程中中间文件的 clean 伪目标, 一般格式如下:
clean:
-rm -f *.o
2.7引用其他的makefile
# Makefile 内容
all:
@echo "主 Makefile begin"
@make other-all
@echo "主 Makefile end"
include ./other/Makefile
2.8 make退出码
Makefile的退出码有以下3种：
- 0 :: 表示成功执行
- 1 :: 表示make命令出现了错误
- 2 :: 使用了 "-q" 选项, 并且make使得一些目标不需要更新
3 Makefile高级语法
3.1定义包
define <command-name> command ... endef
# Makefile 内容
define run-hello-makefile
@echo -n "Hello"
@echo " Makefile!"
@echo "这里可以执行多条 Shell 命令!"
endef
all:
$(run-hello-makefile)
# bash 中运行make
$ make
Hello Makefile!
这里可以执行多条 Shell 命令!
3.2 条件判断
<conditional-directive> <text-if-true> endif # 或者 <conditional-directive> <text-if-true> else <text-if-false> endifeg:
# Makefile 内容
all:
ifeq ("aa", "bb")
@echo "equal"
else
@echo "not equal"
endif
# bash 中执行 make
$ make
not equal
3.3 makefile的函数
Makefile 中自带了一些函数, 利用这些函数可以简化 Makefile 的编写.
函数调用语法如下:
$(<function> <arguments>)
# 或者
${<function> <arguments>}
- <function> 是函数名
- <arguments> 是函数参数
3.3.1字符串函数
字符串替换函数: $(subst <from>,<to>,<text>)
功能: 把字符串<text> 中的 <from> 替换为 <to>
返回: 替换过的字符串
# Makefile 内容
all:
@echo $(subst t,e,maktfilt) <-- 将t替换为e
# bash 中执行 make
$ make
makefile
3.3.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.3.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.3.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.3.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.3.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.3.7 排序函数: $(sort <list>)
功能: 给字符串 <list> 中的单词排序 (升序)
返回: 排序后的字符串
# Makefile 内容
all:
@echo $(sort bac abc acb cab)
# bash 中执行 make
$ make
abc acb bac cab
3.3.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
aa
dd
3.3.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 cc
bb
3.3.10 单词个数统计函数: $(words <text>)
功能: 统计字符串 <text> 中单词的个数
返回: 单词个数
# Makefile 内容
all:
@echo $(words aa bb cc dd)
@echo $(words aabbccdd)
@echo $(words )
# bash 中执行 make
$ make
4
1
0
3.3.11 首单词函数: $(firstword <text>)
功能: 取字符串 <text> 中的第一个单词
返回: 字符串 <text> 中的第一个单词
# Makefile 内容
all:
@echo $(firstword aa bb cc dd)
@echo $(firstword aabbccdd)
@echo $(firstword )
# bash 中执行 make
$ make
aa
aabbccdd
3.3.12 取目录函数: $(dir <names...>)
功能: 从文件名序列 <names> 中取出目录部分
返回: 文件名序列 <names> 中的目录部分
# Makefile 内容
all:
@echo $(dir /home/a.c ./bb.c ../c.c d.c)
# bash 中执行 make
$ make
/home/ ./ ../ ./
3.3.13 取文件函数: $(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.3.14 取后缀函数: $(suffix <names...>)
功能: 从文件名序列 <names> 中取出各个文件名的后缀
返回: 文件名序列 <names> 中各个文件名的后缀, 没有后缀则返回空字符串
# Makefile 内容
all:
@echo $(suffix /home/a.c ./b.o ../c.a d)
# bash 中执行 make
$ make
.c .o .a
3.3.15 取前缀函数: $(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.3.16 加后缀函数: $(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.3.17 加前缀函数: $(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.3.18 连接函数: $(join <list1>,<list2>)
功能: <list2> 中对应的单词加到 <list1> 后面
返回: 连接后的字符串
<pre name="code" class="html"># 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.19 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.3.20 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.3.21 文件名展开函数
功能：功能是展开成一列所有符合由其参数描述的文件名，文件间以空格间隔。函数获取工作目录下的指定格式文件列表
返回：函数返回展开后的文件名列表。
# Makefile内容
all:
@echo $(wildcard *.java)
# bash执行make
$ make
a.java b.java c.java
3.3.22 call - 创建新的参数化函数
语法:
$(call <expression>,<parm1>,<parm2>,<parm3>...)
# Makefile 内容
log = "====debug====" $(1) "====end===="
all:
@echo $(call log,"正在 Make")
# bash 中执行 make
$ make
====debug==== 正在 Make ====end====
3.3.23 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-override
all:
@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.3.24 shell
语法:
$(shell <shell command>)
它的作用就是执行一个shell命令, 并将shell命令的结果作为函数的返回.
作用和 `<shell command>` 一样, ` 是反引号
4 make 控制函数
4.1 产生一个致命错误: $(error <text ...>)
功能: 输出错误信息, 停止Makefile的运行
# Makefile 内容
all:
$(error there is an error!)
@echo "这里不会执行!"
# bash 中执行 make
$ make
Makefile:2: *** there is an error!. Stop.
4.2 输出警告: $(warning <text ...>)
功能: 输出警告信息, Makefile继续运行
# Makefile 内容
all:
$(warning there is an warning!)
@echo "这里会执行!"
# bash 中执行 make
$ make
Makefile:2: there is an warning!
这里会执行!
4.3 GUN约定俗成的伪目标
如果有过在Linux上, 从源码安装软件的经历的话, 就会对 make clean, make install 比较熟悉.
像 clean, install 这些伪目标, 广为人知, 不用解释就大家知道是什么意思了.
下面列举一些常用的伪目标, 如果在自己项目的Makefile合理使用这些伪目标的话, 可以让我们自己的Makefile看起来更专业, 呵呵 :)
| 伪目标 |
含义 |
| all | 所有目标的目标，其功能一般是编译所有的目标 |
| clean | 删除所有被make创建的文件 |
| install | 安装已编译好的程序，其实就是把目标可执行文件拷贝到指定的目录中去 |
| 列出改变过的源文件 | |
| tar | 把源程序打包备份. 也就是一个tar文件 |
| dist | 创建一个压缩文件, 一般是把tar文件压成Z文件. 或是gz文件 |
| TAGS | 更新所有的目标, 以备完整地重编译使用 |
| check 或 test | 一般用来测试makefile的流程 |