如何写Makefile

发表于 2025-06-20 更新于 2025-08-11 分类于 Linux ，基础知识阅读次数：本文字数： 6.3k 阅读时长 ≈ 31 分钟

本文介绍了如何写Makefile文件。

Makefile介绍

使用变量

objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o

edit : $(objects)
	cc -o edit $(objects)
...

⼀个变量的定义很简单，就是⼀个名字（变量名）后跟上⼀个等号，然后在等号的后放这个变量所期望的值。对于变量的引用，则需要采⽤$(变量名)或者${变量名}这种模式。

Makefile 里面有什么

Makefile 里主要包含了五个东西：显式规则、隐晦规则、变量定义、文件指示和注释。

显式规则。显式规则说明了如何生成一个或多个目标文件。这是由Makefile的书写者明显指出要生成的文件、文件的依赖文件和生成的命令。
隐晦规则。由于make有自动推导的功能，所以隐晦的规则可以让我们比较简略地书写Makefile，这是由make 所支持的。
变量的定义。在Makefile 中要定义一系列的变量，变量一般都是字符串，这有点像C中的宏，当Makefile 被执行时，其中的变量会被扩展到相应的引用位置上。
文件指示。其包括了三个部分，一个是在一个Makefile 中引用另一个Makefile，就像C 语言中的include 一样；另一个是指根据某些情况指定Makefile 中的有效部分，就像C 语言中的预编译#if 一样；还有就是定义一个多行的命令。
注释。Makefile 中只有行注释，和UNIX 的Shell 脚本一样，其注释是用# 字符。最后，还值得一提的是，在Makefile 中的命令，必须要以Tab 键开始。

引用其他的Makefile

在Makefile 使用include 关键字可以把别的Makefile 包含进来，语法是：include filename

make的工作方式

GNU 的make 工作时的执行步骤如下：

读入所有的Makefile。
读入被include 的其它Makefile。
初始化文件中的变量。
推导隐晦规则，并分析所有规则。
为所有的目标文件创建依赖关系链。
根据依赖关系，决定哪些目标要重新生成。
执行生成命令。

1-5 步为第一个阶段，6-7 为第二个阶段。第一个阶段中，如果定义的变量被使用了，那么，make会把其展开在使用的位置。但make 并不会完全马上展开，make 使用的是拖延战术，如果变量出现在依赖关系的规则中，那么仅当这条依赖被决定要使用了，变量才会在其内部展开。

书写规则

文件搜寻

Makefile 文件中的特殊变量 VPATH 就是完成这个功能的，如果没有指明这个变量，make 只会在当前的目录中去找寻依赖文件和目标文件。如果定义了这个变量，那么，make 就会在当前目录找不到的情况下，到所指定的目录中去找寻文件了。

VPATH = src:../headers

上面的定义指定两个目录，“src”和“../headers”，make 会按照这个顺序进行搜索。目录由“冒号”分隔。（当然，当前目录永远是最高优先搜索的地方）

书写命令

显示命令

通常，make 会把其要执行的命令行在命令执行前输出到屏幕上。当用@字符在命令行前，那么，这个命令将不被make显示出来，最具代表性的例子是，用这个功能来向屏幕显示一些信息。如:

1	@echo 正在编译XXX 模块......

当make 执行时，会输出“正在编译XXX 模块⋯⋯”字串，但不会输出命令，如果没有“@”，那么，make 将输出:

1 2	echo 正在编译XXX 模块...... 正在编译XXX 模块......

如果make 执行时，带入make 参数-n 或--just-print ，那么其只是显示命令，但不会执行命令，这个功能很有利于调试Makefile，看看书写的命令是执行起来是什么样子的或是什么顺序的。而make 参数-s 或--silent 或--quiet 则是全面禁止命令的显示。

命令出错

每当命令运行完后，make 会检测每个命令的返回码，如果命令返回成功，那么make 会执行下一条命令，当规则中所有的命令成功返回后，这个规则就算是成功完成了。如果一个规则中的某个命令出错了（命令退出码非零），那么make 就会终止执行当前规则，这将有可能终止所有规则的执行。有些时候，命令的出错并不表示就是错误的。例如mkdir 命令，我们一定需要建立一个目录，如果目录不存在，那么mkdir 就成功执行，万事大吉，如果目录存在，那么就出错了。我们之所以使用mkdir的意思就是一定要有这样的一个目录，于是我们就不希望mkdir 出错而终止规则的运行。

为了做到这一点，忽略命令的出错，可以在Makefile 的命令行前加一个减号- （在Tab 键之后），标记为不管命令出不出错都认为是成功的。如：

1 2	clean: -rm -f *.o

还有一个全局的办法是，给make 加上-i 或是--ignore-errors 参数，那么，Makefile 中所有命令都会忽略错误。而如果一个规则是以.IGNORE 作为目标的，那么这个规则中的所有命令将会忽略错误。这些是不同级别的防止命令出错的方法，你可以根据你的不同喜欢设置。

还有一个make 的参数的是-k 或是--keep-going ，这个参数的意思是，如果某规则中的命令出错了，那么就终止该规则的执行，但继续执行其它规则。

使用变量

变量赋值的区别

Makefile 中有几种不同的变量赋值方式：

赋值方式	示例	特点
`=`（递归展开）	`A = $(B)`	使用时才展开，可能受后续赋值影响
`:=`（立即展开）	`A := $(B)`	定义时立即展开，后续赋值不影响
`?=`（条件赋值）	`A ?= default`	仅当变量未定义时赋值
`+=`（追加赋值）	`A += value`	向已有变量追加值

使用函数

函数的调用语法

1	$(<function> <arguments>)

或

1	${<function> <arguments>}

这里，<function>就是函数名。<arguments> 为函数的参数，参数间以逗号分隔，而函数名和参数之间以“空格”分隔。

字符串处理函数

subst

1	$(subst <from>,<to>,<text>)

名称：字符串替换函数。
功能：把字符串<text>中的<from>字符串替换成<to>。
返回：函数返回被替换过后的字符串。
示例：$(subst ee,EE,feet on the street)，结果返回 $\textrm{fEEt on the strEEt}$。

patsubst

1	$(patsubst <pattern>,<replacement>,<text>)

名称：模式字符串替换函数
功能：查找<text> 中的单词（单词以“空格”、“Tab”或“回车”“换行”分隔）是否符合模式<pattern> ，如果匹配的话，则以<replacement> 替换。这里，<pattern> 可以包括通配符% ，表示任意长度的字串。如果<replacement> 中也包含% ，那么，<replacement> 中的这个% 将是<pattern>中的那个% 所代表的字串。（可以用\来转义，以\% 来表示真实含义的%字符）
返回：被替换过后的字符串
示例：$(patsubst %.c,%.o,x.c.c bar.c)，把字串x.c.c bar.c 符合模式%.c 的单词替换成%.o ，返回结果是x.c.o bar.o

strip

1	$(strip <string>)

名称：去空格函数
功能：去掉<string>字符中开头和结尾的空字符
返回：被去掉空格的字符串值
示例：$(strip a b c ) 去掉字符串开头结尾的空格。

findstring

1	$(findstring <find>,<in>)

名称：查找字符串函数
功能：在字符串<in>中查找<find>字符串。
返回：如果找到，返回<find>，否则返回空字符串。
示例： $(findstring a,a b c); $(findstring a,b c)，第一个函数返回a 字符串，第二个返回空字符串

filter

1	$(filter <pattern...>,<text>)

名称：过滤函数
功能：以<pattern> 模式过滤<text> 字符串中的单词，保留符合模式<pattern> 的单词。可以有多个模式。
返回：返回符合模式<pattern> 的字串。
示例：

1
2
3

sources := foo.c bar.c baz.s ugh.h
foo: $(sources)
	cc $(filter %.c %.s,$(sources)) -o foo

$(filter %.c %.s,$(sources)) 返回的值是foo.c bar.c baz.s 。

filter-out

1	$(filter-out <pattern...>,<text>)

名称：反过滤函数
功能：以<pattern> 模式过滤<text> 字符串中的单词，去除符合模式<pattern> 的单词。可以有多个模式。
返回：返回不符合模式<pattern> 的字串。
示例：

1 2	objects=main1.o foo.o main2.o bar.o mains=main1.o main2.o

$(filter-out $(mains),$(objects)) 返回值是foo.o bar.o 。

sort

1	$(sort <list>)

名称：排序函数
功能：给字符串<list>中的单词排序（升序）。
返回：返回排序后的字符串。
示例：$(sort foo bar lose) 返回 bar foo lose。
备注：sort函数会去掉重复的单词。

word

1	$(word <n>,<text>)

名称：取单词函数
功能：取字符串<text>中第<n>个单词。（从1开始）
返回：返回排字符串<text>中第<n>个单词。如果<n>比<text>中的单词数大，返回空字符串。
示例：$(word 2, foo bar baz) 返回 bar。

wordlist

1	$(wordlist <ss>,<e>,<text>)

名称：取单词串函数
功能：从字符串<text>中取从<ss>到<e>的单词串。<ss>和<e>是一个数字。
返回：返回字符串<text>中取从<ss>到<e>的单词串。。如果<ss>比<text>中的单词数大，返回空字符串。如果<e>大于<text>单词数，返回从<ss>开始，到<text>结束的单词串。
示例：$(wordlist 2,3, foo bar baz) 返回 bar baz。

words

1	$(wordlist <text>)

名称：单词个数统计函数
功能：统计<text>中字符串中单词个数。
返回：单词个数。
示例：$(words foo bar baz) 返回 3。
备注：若取<text>中最后一个单词，可以 $(word $(words <text>), <text>)。

firstword

1	$(firstword <text>)

名称：首单词函数。
功能：取字符串<text>中的第一个单词。
返回：字符串<text>中的第一个单词。
示例：$(firstword foo bar baz) 返回 foo。
备注：该函数可以用word函数实现： $(word 1, <text>)。

文件名操作函数

dir

1	$(dir <names...>)

名称：取目录函数。
功能：从文件名序列<names> 中取出目录部分。目录部分是指最后一个反斜杠（/ ）之前的部分。如果没有反斜杠，那么返回./。
返回：文件名序列<names> 中目录部分。
示例：$(dir src/foo.c hacks) 返回 src/ ./。

notdir

1	$(notdir <names...>)

名称：取文件函数。
功能：从文件名序列<names> 中取出非目录部分。目录部分是指最后一个反斜杠（/ ）之后的部分。
返回：文件名序列<names> 中非目录部分。
示例：$(notdir src/foo.c hacks) 返回 foo.c hacks。

suffix

1	$(suffix <names...>)

名称：取后缀函数。
功能：从文件名序列<names> 中取出各个文件名的后缀。
返回：文件名序列<names> 的后缀序列，如果文件没有后缀，则返回空字符串。
示例：$(suffix src/foo.c src-1/bar.c hacks) 返回 .c .c。

basename

1	$(basename <names...>)

名称：取前缀函数。
功能：从文件名序列<names> 中取出各个文件名的前缀部分。
返回：文件名序列<names> 的前缀序列，如果文件没有前缀，则返回空字符串。
示例：$(suffix src/foo.c src-1.0/bar.c hacks) 返回 src/foo src-1.0/bar hacks。

addsuffix

1	$(addsuffix <suffix>,<names...>)

名称：加后缀函数。
功能：把后缀<suffix>加到<names>中的每个单词后面。
返回：加过后缀的文件名序列。
示例：$(addsuffix .c, foo bar) 返回 foo.c bar.c。

addprefix

1	$(addprefix <suffix>,<names...>)

名称：加前缀函数。
功能：把前缀<prefix>加到<names>中的每个单词前面。
返回：加过前缀的文件名序列。
示例：$(addprefix src/, foo bar) 返回 src/foo src/bar。

join

1	$(join <list1>,<list2>)

名称：连接函数。
功能：把<list2> 中的单词对应地加到<list1>的单词后面。如果<list1> 的单词个数要比<list2> 的多，那么，<list1> 中的多出来的单词将保持原样。如果<list2>的单词个数要比<list1>多，那么，<list2> 多出来的单词将被复制到<list1> 中。
返回：返回连接过后的字符串。
示例：$(join aaa bbb, 111 222 333) 返回 aaa111 bbb222 333。

foreach函数

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

这个函数的意思是，把参数<list> 中的单词逐一取出放到参数<var>所指定的变量中，然后再执行<text> 所包含的表达式。每一次<text> 会返回一个字符串，循环过程中，<text> 的所返回的每个字符串会以空格分隔，最后当整个循环结束时，<text> 所返回的每个字符串所组成的整个字符串（以空格分隔）将会是foreach 函数的返回值。

所以，<var> 最好是一个变量名，<list> 可以是一个表达式，而<text> 中一般会使用<var> 这个参数来依次枚举<list> 中的单词。举个例子：

1 2	names := a b c d files := $(foreach n,$(names),$(n).o)

上面的例子中，$(names) 中的单词会被挨个取出，并存到变量n中，$(n).o 每次根据$(n) 计算出一个值，这些值以空格分隔，最后作为foreach 函数的返回，所以，$(files) 的值是a.o b.o c.o d.o。注意，foreach 中的<var> 参数是一个临时的局部变量，foreach 函数执行完后，参数<var> 的变量将不在作用，其作用域只在foreach 函数当中。

if函数

1
2
3

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

可见，if 函数可以包含“else”部分，或是不含。即if函数的参数可以是两个，也可以是三个。<condition> 参数是if 的表达式，如果其返回的为非空字符串，那么这个表达式就相当于返回真，于是，<then-part> 会被计算，否则<else-part> 会被计算。

call函数

call 函数是唯一一个可以用来创建新的参数化的函数。其语法是：

1	$(call <expression>,<parm1>,<parm2>,...,<parmn>)

当make 执行这个函数时，<expression> 参数中的变量，如$(1) 、$(2) 等，会被参数<parm1>、<parm2> 、<parm3> 依次取代。而<expression> 的返回值就是call 函数的返回值。例如：

1 2	reverse = $(1) $(2) foo = $(call reverse,a,b)

那么，foo 的值就是a b 。当然，参数的次序是可以自定义的，不一定是顺序的，如：

1 2	reverse = $(2) $(1) foo = $(call reverse,a,b)

此时的foo的值就是b a 。

需要注意：在向call函数传递参数时要尤其注意空格的使用。call 函数在处理参数时，第2 个及其之后的参数中的空格会被保留，因而可能造成一些奇怪的效果。因而在向call 函数提供参数时，最安全的做法是去除所有多余的空格。

origin函数

origin 函数不像其它的函数，他并不操作变量的值，他只是告诉你你的这个变量是哪里来的？其语法是：

1	$(origin <variable>)

注意，<variable>是变量的名字，不应该是引用。所以最好不要在variable中使用$字符。

origin 函数会以其返回值来告诉你这个变量的“出生情况”，下面，是origin 函数的返回值:

undefined 如果<variable> 从来没有定义过，origin 函数返回这个值undefined

default 如果<variable> 是一个默认的定义，比如“CC”这个变量。

environment 如果<variable> 是一个环境变量，并且当Makefile 被执行时，-e 参数没有被打开。

file 如果<variable> 这个变量被定义在Makefile 中。

command line 如果<variable> 这个变量是被命令行定义的。

override 如果<variable> 是被override 指示符重新定义的。

automatic 如果<variable> 是一个命令运行中的自动化变量。

shell函数

shell 函数它的参数应该就是操作系统Shell的命令。它和反引号是相同的功能。这就是说，shell 函数把执行操作系统命令后的输出作为函数返回。于是，我们可以用操作系统命令以及字符串处理命令awk，sed 等等命令来生成一个变量，如：

1 2	contents := $(shell cat foo) files := $(shell echo *.c)

注意，这个函数会新生成一个Shell程序来执行命令，所以你要注意其运行性能，如果你的Makefile 中有一些比较复杂的规则，并大量使用了这个函数，那么对于你的系统性能是有害的。特别是Makefile 的隐晦的规则可能会让你的shell 函数执行的次数比你想像的多得多。

控制make的函数

make 提供了一些函数来控制make 的运行。通常，你需要检测一些运行Makefile 时的运行时信息，并且根据这些信息来决定，你是让make 继续执行，还是停止。

1	$(error <text ...>)

产生一个致命的错误，<text ...> 是错误信息。注意，error 函数不会在一被使用就会产生错误信息，所以如果你把其定义在某个变量中，并在后续的脚本中使用这个变量，那么也是可以的。例如：

# 示例一
ifdef ERROR_001
	$(error error is $(ERROR_001))
endif

# 示例二
ERR = $(error found an error!)
.PHONY: err
err: $(ERR)

示例一会在变量 ERROR_001 定义了后执行时产生error 调用，而示例二则在目标err 被执行时才发生error 调用。

1	$(warning <text ...>)

这个函数很像error函数，只是它并不会让make退出，只是输出一段警告信息，而make 继续执行。

make的运行

make的退出码

make 命令执行后有三个退出码：

0 表示成功执行。

1 如果make 运行时出现任何错误，其返回1。

2 如果你使用了make 的“-q”选项，并且make 使得一些目标不需要更新，那么返回2。

指定Makefile

GNU make 找寻默认的Makefile 的规则是在当前目录下依次找三个文件——“GNUmakefile”、“makefile”和“Makefile”。其按顺序找这三个文件，一旦找到，就开始读取这个文件并执行。

也可以给make 命令指定一个特殊名字的Makefile。要达到这个功能，我们要使用make的-f 或是–file 参数（–makefile 参数也行）。例如，有个makefile 的名字是“hchen.mk”，那么，我们可以这样来让make 来执行这个文件：make –f hchen.mk。

如果在make 的命令行是，不只一次地使用了-f 参数，那么，所有指定的makefile 将会被连在一起传递给make执行。

指定目标

即然make 可以指定所有makefile 中的目标，那么也包括“伪目标”，于是可以根据这种性质来让我们的makefile 根据指定的不同的目标来完成不同的事。在Unix 世界中，软件发布时，特别是GNU 这种开源软件的发布时，其makefile 都包含了编译、安装、打包等功能。可以参照这种规则来书写我们的makefile 中的目标。

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

隐含规则

隐含规则使用的变量

关于命令的变量

命令变量	解释 \| 默认命令
AR	函数库打包程序。默认命令是ar
AS	汇编语言编译程序。默认命令是as
CC	C 语言编译程序。默认命令是cc
CXX	C++ 语言编译程序。默认命令是g++
CO	从RCS 文件中扩展文件程序。默认命令是co
CPP	C 程序的预处理器（输出是标准输出设备）。默认命令是$(CC) –E
FC	Fortran 和Ratfor 的编译器和预处理程序。默认命令是f77
GET	从SCCS 文件中扩展文件的程序。默认命令是get
LEX	Lex 方法分析器程序（针对于C 或Ratfor）。默认命令是lex
PC	Pascal 语言编译程序。默认命令是pc
YACC	Yacc 文法分析器（针对于C 程序）。默认命令是yacc
YACCR	Yacc 文法分析器（针对于Ratfor 程序）。默认命令是yacc –r
MAKEINFO	转换Texinfo 源文件（.texi）到Info 文件程序。默认命令是makeinfo
TEX	从TeX 源文件创建TeX DVI 文件的程序。默认命令是tex
TEXI2DVI	从Texinfo 源文件创建TeX DVI 文件的程序。默认命令是texi2dvi
WEAVE	转换Web 到TeX 的程序。默认命令是weave
CWEAVE	转换C Web 到TeX 的程序。默认命令是cweave
CTANGLE	转换C Web 到C。默认命令是ctangle
RM	删除文件命令。默认命令是rm –f

关于命令参数的变量

下面的这些变量都是相关上面的命令的参数。如果没有指明其默认值，那么其默认值都是空。

命令参数的变量	解释 \| 默认命令
ARFLAGS	函数库打包程序AR 命令的参数。默认值是rv
ASFLAGS	汇编语言编译器参数。（当明显地调用.s 或.S 文件时）
CFLAGS	C 语言编译器参数
CXXFLAGS	C++ 语言编译器参数
COFLAGS	RCS 命令参数
CPPFLAGS	C 预处理器参数（C 和Fortran 编译器也会用到）
FFLAGS	Fortran 语言编译器参数
GFLAGS	SCCS “get”程序参数
LDFLAGS	链接器参数（如：ld ）
LFLAGS	Lex 文法分析器参数
PFLAGS	Pascal 语言编译器参数
RFLAGS	Ratfor 程序的Fortran 编译器参数
YFLAGS	Yacc 文法分析器参数

定义模式规则

自动化变量

下面是所有的自动化变量及其说明：

自动化变量	说明
`$@`	表示规则中的目标文件集。
`$%`	仅当目标是函数库文件中，表示规则中的目标成员名。例如，如果一个目标是foo.a(bar.o)，那么，`$%` 就是bar.o ，`$@` 就是foo.a 。如果目标不是函数库文件（Unix 下是.a ，Windows下是.lib），那么，其值为空。
`$<`	依赖目标中的第一个目标名字。如果依赖目标是以模式（即`%`）定义的，那么`$<`将是符合模式的一系列的文件集。注意，其是一个一个取出来的。
`$?`	所有比目标新的依赖目标的集合。以空格分隔。
`$^`	所有的依赖目标的集合。以空格分隔。如果在依赖目标中有多个重复的，那个这个变量会去除重复的依赖目标，只保留一份。
`$+`	这个变量很像`$^` ，也是所有依赖目标的集合。只是它不去除重复的依赖目标。
`$*`	这个变量表示目标模式中`%` 及其之前的部分。如果目标是`dir/a.foo.b` ，并且目标的模式是`a.%.b` ，那么，`$*` 的值就是`dir/a.foo` 。

在上述所列出来的自动量变量中。四个变量（$@ 、$< 、$% 、$* ）在扩展时只会有一个文件，而另三个的值是一个文件列表。这七个自动化变量还可以取得文件的目录名或是在当前目录下的符合模式的文件名，只需要搭配上D 或F 字样。这是GNU make 中老版本的特性，在新版本中，我们使用函数dir 或notdir 就可以做到了。D 的含义就是Directory，就是目录，F 的含义就是File，就是文件。

这些变量只使用在规则的命令中，而且一般都是“显式规则”和“静态模式规则”。其在隐含规则中并没有意义。

使用make更新函数库文件

函数库文件的成员

一个函数库文件由多个文件组成。你可以用如下格式指定函数库文件及其组成:

1	archive(member)

这个不是一个命令，而一个目标和依赖的定义。一般来说，这种用法基本上就是为了ar 命令来服务的。如:

1 2	foolib(hack.o) : hack.o ar cr foolib hack.o

如果要指定多个member，那就以空格分开，如: foolib(hack.o kludge.o)，其等价于foolib(hack.o) foolib(kludge.o)

还可以使用Shell的文件通配符来定义,如：

1	foolib(*.o)

模板

每个.c编译成.o再链接在一起

OUT:=main
SRCS:=$(wildcard *.c)
OBJS:=$(patsubst %.c,%.o,$(SRCS))
CC:=gcc
$(OUT):$(OBJS)
	$(CC) $^ -o $@ -lpthread
%.o:%.c
	$(CC) -c $^ -o $@ -g
.PHONY:clean rebuild
clean:
	$(RM) $(OBJS) $(OUT)
rebuild: clean main

每个.c文件各自编译链接成可执行文件

SRCS:=$(wildcard *.c)
EXES:=$(patsubst %.c,%,$(SRCS))
CC:=gcc
all:$(EXES)
%:%.c
	$(CC) $^ -o $@ -g
clean:
	$(RM) $(EXES)
rebuild:clean all

参考博文

makefile详解
跟我一起写Makefile.陈皓.