make 是最常用的构建工具,不仅仅用于c/c++,很多项目都可以通过编写makefile 进行自动化编译,测试,安装
本文 主要参考 阮一峰的博客 自己进行学习&测试
Make 命令使用
基本用法
make [target]
注:make自动在当前目录中寻找名为Makefile / makefile 的文件,target 定义在Makefile中
Makefile 语法
概要
Makefile 由一系列规则组成,最常见的规则如下:
<target> : <prerequisites>
[tab] <commands>
冒号两端有空格,冒号前面的部分,叫做”目标”(target),冒号后面的部分叫做”前置条件”(prerequisites);
第二行必须由一个tab键起首,后面跟着”命令”(commands)。
“目标”是必需的,不可省略;”前置条件”和”命令”都是可选的,但是两者之中必须至少存在一个。
target
目标通常是文件名,指明Make命令所要构建的对象。目标可以是一个文件名,也可以是多个文件名,之间用空格分隔。
除了文件名,目标还可以是某个操作的名字,这称为”伪目标”(phony target)。
一般来讲,如果target是一个文件,且已经存在,Make命令就不会再根据前置条件 执行命令(前置条件无变化前提下)
clean:
find . -name "*.tmp"|xargs rm
上面代码的目标是clean,前置条件为空,它不是文件名,而是一个操作的名字,属于”伪目标 “,命令是删除对象文件。
使用方法如下
$ make clean
但是,如果当前目录中,正好有一个文件叫做clean,那么这个命令不会执行。因为Make发现clean文件已经存在,就认为没有必要重新构建了。
为了避免这种情况,可以明确声明clean是”伪目标”,写法如下。
.PHONY: clean
clean:
find . -name "*.tmp"|xargs rm
声明clean是”伪目标”之后,make就不会去检查是否存在一个叫做clean的文件,而是每次运行都执行对应的命令。像.PHONY这样的内置目标名还有不少,可以查看手册。
如果Make命令运行时没有指定目标,默认会执行Makefile文件的第一个目标。
$ make
上面代码执行Makefile文件的第一个目标。
前置条件
前置条件通常是一组文件名,之间用空格分隔。
前置条件指定了”目标”是否重新构建的判断标准:只要有一个前置文件不存在,或者有过更新(前置文件的last-modification时间戳比目标的时间戳新),”目标”就需要重新构建。
result.txt: source1.txt source2.txt
cat source1.txt source2.txt > result.txt
上面代码中,构建 result.txt 的前置条件是 source1.txt
source2.txt。如果当前目录中,source1.txt source2.txt 已经存在,那么make
result.txt可以正常运行,否则必须再写一条规则,来生成 source.txt 。
source1.txt:
echo "this is the source1" > source1.txt
source2.txt:
echo "this is the source2" > source2.txt
$ make result.txt
$ make result.txt
连续执行两次make result.txt。
第一次执行会先新建 source.txt,然后再新建 result.txt。
第二次执行,Make发现 source.txt 没有变动(时间戳晚于 result.txt),就不会执行任何操作,result.txt 也不会重新生成。
如果需要生成多个文件,往往采用下面的写法。
source: file1 file2 file3
上面代码中,source 是一个伪目标,只有三个前置文件,没有任何对应的命令。
$ make source
执行make source命令后,就会一次性生成 file1,file2,file3 三个文件。
命令
命令(commands)表示如何更新目标文件,由一行或多行的Shell命令组成。它是构建”目标”的具体指令,它的运行结果通常就是生成目标文件。
每行命令之前必须有一个tab键
需要注意的是,每行命令在一个单独的shell中执行。这些Shell之间没有继承关系。
var-lost:
export foo=bar
echo "foo=[$$foo]" # 注意是两个$
上面代码执行后(make var-lost),取不到foo的值。因为两行命令在两个不同的进程执行。一个解决办法是将两行命令写在一行,中间用分号分隔。
var-kept:
export foo=bar; echo "foo=[$$foo]" # 注意是两个$
另一个解决办法是在换行符前加反斜杠转义。
var-kept:
export foo=bar; \
echo "foo=[$$foo]" # 注意是两个$
Makefile 语法
1注释
使用#作为注释
test:
# 这是注释
2 回声
正常情况下,make会打印每条命令(包括注释),然后再执行,这就叫做回声(echoing)
$ make test
# haha
在命令的前面加上@,就可以关闭回声。
test:
@# 这是测试
现在再执行
make test
,就不会有任何输出。
由于在构建过程中,需要了解当前在执行哪条命令,所以通常只在注释和纯显示的echo命令前面加上@。因为echo的内容会打印出来,只是不显示echo “*” 这条命令
test:
@# 这是测试
@echo TODO
3 通配符
通配符(wildcard)用来指定一组符合条件的文件名。Makefile 的通配符与 Bash 一致,主要有星号()、问号(?)和 […] 。比如, .o 表示所有后缀名为o的文件。
clean:
rm -f *.o
4 模式匹配
Make命令允许对文件名,进行类似正则运算的匹配,主要用到的匹配符是%。比如,假定当前目录下有 f1.c 和 f2.c两个源码文件,需要将它们编译为对应的对象文件。
%.o: %.c
等同于下面的写法。
f1.o: f1.c
f2.o: f2.c
使用匹配符%,可以将大量同类型的文件,只用一条规则就完成构建。
5 变量和赋值符
Makefile 允许使用等号自定义变量。
txt = Hello World
test:
@echo $(txt) #只需要一个$
上面代码中,变量 txt 等于 Hello World。调用时,变量需要放在 $( ) 之中。注:这是Makefile语法,$() ,只需要一个$
调用Shell变量,需要在美元符号前,再加一个美元符号,这是因为Make命令会对美元符号转义。
test:
@echo $$HOME
有时,变量的值可能指向另一个变量。
v1 = $(v2)
上面代码中,变量 v1 的值是另一个变量 v2。这时会产生一个问题,v1 的值到底在定义时扩展(静态扩展),还是在运行时扩展(动态扩展)?如果 v2 的值是动态的,这两种扩展方式的结果可能会差异很大。
为了解决类似问题,Makefile一共提供了四个赋值运算符 (=、:=、?=、+=)。
VARIABLE = value
在执行时扩展,允许递归扩展
VARIABLE := value
在定义时扩展
VARIABLE ?= value
只有在该变量为空时才设置值
VARIABLE += value
将值追加到变量的尾端
6 内置变量(Implicit Variables)
Make命令提供一系列内置变量,比如,$(CC)
指向当前使用的编译器,$(MAKE)
指向当前使用的Make工具。这主要是为了跨平台的兼容性,详细的内置变量查手册。
output:
$(CC) -o output input.c
7 自动变量(Automatic Variables)
Make命令还提供一些自动变量,它们的值与当前规则有关。主要有以下几个。
$@
指代当前目标,就是Make命令当前构建的那个目标。比如,make foo
的 $@
就指代foo
。
a.txt b.txt:
touch $@
等同于下面的写法。
a.txt:
touch a.txt
b.txt:
touch b.txt
$<
指代第一个前置条件。比如,规则为 t: p1 p2
,那么$<
就指代p1。
a.txt: b.txt c.txt
cp $< $@
等同于下面的写法。
a.txt: b.txt c.txt
cp b.txt a.txt
$?
指代比目标更新的所有前置条件,之间以空格分隔。比如,规则为t: p1 p2
,其中p2
的时间戳比 t 新,$?
就指代p2
。
$^
指代所有前置条件,之间以空格分隔。比如,规则为t: p1 p2
,那么$^
就指代p1 p2
。
$*
指代匹配符 % 匹配的部分, 比如% 匹配 f1.txt 中的f1 ,$*
就表示f1
。
%.txt : %.log
@echo $* $<
$ make a.text
输出 a.txt a.log
$(@D)
和$(@F)
分别指向$@
的目录名和文件名。比如,$@
是src/input.c
,那么$(@D)
的值为 src ,$(@F)
的值为input.c
。
$(<D)
和$(<F)
分别指向$<
的目录名和文件名。
所有的自动变量清单,请看手册。下面是自动变量的一个例子。
dest/%.txt: src/%.txt
@[ -d dest ] || mkdir dest
cp $< $@
上面代码将 src 目录下的 txt 文件,拷贝到 dest 目录下。首先判断 dest 目录是否存在,如果不存在就新建,然后,
$<
指代前置文件(src/%.txt)
,$@
指代目标文件(dest/%.txt)
。
8 判断和循环
Makefile使用 Bash 语法,完成判断和循环。
ifeq ($(CC),gcc)
libs=$(libs_for_gcc)
else
libs=$(normal_libs)
endif
上面代码判断当前编译器是否 gcc ,然后指定不同的库文件。
LIST = one two three
all:
for i in $(LIST); do \
echo $$i; \ # shell变量, 两个$
done
9 函数
待添加
Makefile 的实例
执行多个目标
.PHONY: cleanall cleanobj cleandiff
cleanall : cleanobj cleandiff
rm program
cleanobj :
rm *.o
cleandiff :
rm *.diff
上面代码可以调用不同目标,删除不同后缀名的文件,也可以调用一个目标(cleanall),删除所有指定类型的文件。
(2)编译C语言项目
edit : main.o kbd.o command.o display.o
cc -o edit main.o kbd.o command.o display.o
main.o : main.c defs.h
cc -c main.c
kbd.o : kbd.c defs.h command.h
cc -c kbd.c
command.o : command.c defs.h command.h
cc -c command.c
display.o : display.c defs.h
cc -c display.c
clean :
rm edit main.o kbd.o command.o display.o
.PHONY: edit clean