GNU Make 使用手册(中译版)
翻译:于凤昌
译者注:本人在阅读 Linux 源代码过程中发现如果要全面了解 Linux 的结构、理解 Linux
的编程总体设计及思想必须首先全部读通 Linux 源代码中各级的 Makefile 文件。目前,在
网上虽然有一些著作,但都不能全面的解释 Linux 源代码中各级的 Makefile 文件,因此本
人认真阅读了 GNU Make 使用手册(3.79)版原文,在此基础上翻译了该手册,以满足对Linux
源代码有兴趣或者希望采用 GCC 编写程序但对缺乏 GNU Make 全面了解之人士的需要。本人
是业余爱好 不是专业 翻译人 士,如果有 问题请 通过电子信箱与我联系共同商讨 ,本人的
E-mail 为:yfc70@public2.lyptt.ha.cn 。注意在文章中出现的斜体加粗字表示章节。
GNU make Version 3.79
April 2000
目录
Richard M. Stallman and Roland McGrath
1 make 概述
1.1 怎样阅读本手册
1.2 问题和 BUG
2 Makefile 文件介绍
2.1 规则的格式
2.2 一个简单的 Makefile 文件
2.3make 处理 Makefile 文件的过程
2.4 使用变量简化 Makefile 文件
2.5 让 make 推断命令
2.6 另一种风格的 Makefile 文件
2.7 在目录中删除文件的规则
3 编写 Makefile 文件
3.1Makefile 文件的内容
3.2Makefile 文件的命名
3.3 包含其它的 Makefile 文件
3.4 变量 MAKEFILES
3.5Makefile 文件重新生成的过程
3.6 重载其它 Makefile 文件
3.7make 读取 Makefile 文件的过程
4 编写规则
4.1 规则的语法
4.2 在文件名中使用通配符
4.2.1 通配符例子
4.2.2 使用通配符的常见错误
4.2.3 函数 wildcard
4.3 在目录中搜寻依赖
4.3.1VPATH:所有依赖的搜寻路径
4.3.2vpath 指令
4.3.3 目录搜寻过程
4.3.4 编写搜寻目录的 shell 命令
4.3.5 目录搜寻和隐含规则
4.3.6 连接库的搜寻目录
4.4 假想目标
4.5 没有命令或依赖的规则
4.6 使用空目录文件记录事件
4.7 内建的特殊目标名
4.8 具有多个目标的规则
4.9 具有多条规则的目标
4.10 静态格式规则
4.10.1 静态格式规则的语法
4.10.2 静态格式规则和隐含规则
4.11 双冒号规则
4.12 自动生成依赖
5 在规则中使用命令
5.1 命令回显
5.2 执行命令
5.3 并行执行
5.4 命令错误
5.5 中断或关闭 make
5.6 递归调用 make
5.6.1 变量 MAKE 的工作方式
5.6.2 与子 make 通讯的变量
5.6.3 与子 make 通讯的选项
5.6.4`--print-directory'选项
5.7 定义固定次序命令
5.8 使用空命令
6 使用变量
6.1 变量引用基础
6.2 变量的两个特色
6.3 变量高级引用技术
6.3.1 替换引用
6.3.2 嵌套变量引用
6.4 变量取值
6.5 设置变量
6.6 为变量值追加文本
6.7override 指令
6.8 定义多行变量
6.9 环境变量
6.10 特定目标变量的值
6.11 特定格式变量的值
7 Makefile 文件的条件语句
7.1 条件语句的例子
7.2 条件语句的语法
7.3 测试标志的条件语句
8 文本转换函数
8.1 函数调用语法
8.2 字符串替换和分析函数
8.3 文件名函数
8.4 函数 foreach
8.5 函数 if
8.6 函数 call
8.7 函数 origin
8.8 函数 shell
8.9 控制 Make 的函数
9 运行 make
9.1 指定 Makefile 文件的参数
9.2 指定最终目标的参数
9.3 代替执行命令
9.4 避免重新编译文件
9.5 变量重载
9.6 测试编译程序
9.7 选项概要
10 使用隐含规则
10.1 使用隐含规则
10.2 隐含规则目录
10.3 隐含规则使用的变量
10.4 隐含规则链
10.5 定义与重新定义格式规则
10.5.1 格式规则简介
10.5.2 格式规则的例子
10.5.3 自动变量
10.5.4 格式匹配
10.5.5 万用规则
10.5.6 删除隐含规则
10.6 定义最新类型的缺省规则
10.7 过时的后缀规则
10.8 隐含规则搜寻算法
11 使用 make 更新档案文件
11.1 档案成员目标
11.2 档案成员目标的隐含规则
11.2.1 更新档案成员的符号索引表
11.3 使用档案的危险
11.4 档案文件的后缀规则
12 GNU make 的特点
13 不兼容性和失去的特点
14 Makefile 文件惯例
14.1makefile 文件的通用惯例
14.2makefile 文件的工具
14.3 指定命令的变量
14.4 安装路径变量
14.5 用户标准目标
14.6 安装命令分类
15 快速参考
16make 产生的错误
17 复杂的 Makefile 文件例子
附录 名词翻译对照表
1 Make 概述
Make 可自动决定一个大程序中哪些文件需要重新编译,并发布重新编译它们的命令。
本版本 GNU Make使用手册由 Richard M. Stallman and Roland McGrath编著,是从 Paul D.
Smith 撰写的 V3.76 版本发展过来的。
GNU Make 符合 IEEE Standard 1003.2-1992 (POSIX.2) 6.2 章节的规定。
因为 C 语言程序更具有代表性,所以我们的例子基于 C 语言程序,但 Make 并不是仅仅
能够处理 C 语言程序,它可以处理那些编译器能够在 Shell 命令下运行的的各种语言的程序。
事实上,GNU Make 不仅仅限于程序,它可以适用于任何如果一些文件变化导致另外一些文
件必须更新的任务。
如果要使用 Make,必须先写一个称为 Makefile 的文件,该文件描述程序中各个文件之
间的相互关系,并且提供每一个文件的更新命令。在一个程序中,可执行程序文件的更新依
靠 OBJ 文件,而 OBJ 文件是由源文件编译得来的。
一旦合适的 Makefile 文件存在,每次更改一些源文件,在 shell 命令下简单的键入:
make
就能执行所有的必要的重新编译任务。Make 程序根据 Makefile 文件中的数据和每个文件更
改的时间戳决定哪些文件需要更新。对于这些需要更新的文件,Make 基于 Makefile 文件发
布命令进行更新,进行更新的方式由提供的命令行参数控制。具体操作请看运行Make 章节。
1.1 怎样阅读本手册
如果您现在对 Make 一无所知或者您仅需要了解对 make 的普通性介绍,请查阅前几章
内容,略过后面的章节。前几章节是普通介绍性内容,后面的章节是具体的专业、技术内容。
如果您对其它 Make 程序十分熟悉,请参阅 GNU Make 的特点和不兼容性和失去的特点
部分,GNU Make 的特点这一章列出了 GNU Make 对 make 程序的扩展,不兼容和失去的特点
一章解释了其它 Make 程序有的特征而 GNU Make 缺乏的原因。
对于快速浏览者,请参阅选项概要、快速参考和内建的特殊目标名部分。
1.2 问题和 BUG
如果您有关于 GNU Make 的问题或者您认为您发现了一个 BUG,请向开发者报告;我们
不能许诺我们能干什么,但我们会尽力修正它。在报告 BUG 之前,请确定您是否真正发现了
BUG,仔细研究文档后确认它是否真的按您的指令运行。如果文档不能清楚的告诉您怎么做,
也要报告它,这是文档的一个 BUG。
在您报告或者自己亲自修正 BUG 之前,请把它分离出来,即在使问题暴露的前提下尽可
能的缩小 Makefile 文件。然后把这个 Makefile 文件和 Make 给出的精确结果发给我们。同
时请说明您希望得到什么,这可以帮助我们确定问题是否出在文档上。
一旦您找到一个精确的问题,请给我们发 E-mail,我们的 E-mail 地址是:
bug-make@gnu.org
在邮件中请包含您使用的 GNU Make的版本号。您可以利用命令‘make--version’得到
版本号。同时希望您提供您 的机器型号和操作系统类型,如有 可能的话,希望 同时提供
config.h 文件(该文件有配置过程产生)。
2 Makefile 文件介绍
Make 程序需要一个所谓的 Makefile 文件来告诉它干什么。在大多数情况下,Makefile
文件告诉 Make 怎样编译和连接成一个程序。
本章我们将讨论一个简单的 Makefile 文件,该文件描述怎样将 8 个 C 源程序文件和 3
个头文件编译和连接成为一个文本编辑器。Makefile 文件可以同时告诉 Make 怎样运行所需
要的杂乱无章的命令(例如, 清除操作时删除特定 的文件)。如果要看更详细 、复杂的
Makefile 文件例子,请参阅复杂的Makefile 文件例子一章。
当 Make 重新编译这个编辑器时,所有改动的 C 语言源文件必须重新编译。如果一个头
文件改变,每一个包含该头文件的 C 语言源文件必须重新编译,这样才能保证生成的编辑器
是所有源文件更新后的编辑器。每一个 C 语言源文件编译后产生一个对应的 OBJ 文件,如果
一个源文件重新编译,所有的 OBJ 文件无论是刚刚编译得到的或原来编译得到的必须从新连
接,形成一个新的可执行文件。
2.1 规则的格式
一个简单的 Makefile 文件包含一系列的“规则”,其样式如下:
目标(target)…: 依赖(prerequiries)…
命令(command)
…
…
目标(target)通常是要产生的文件的名称,目标的例子是可执行文件或 OBJ 文件。目标
也可是一个执行的动作名称,诸如‘clean’(详细内容请参阅假想目标一节)。
依赖是用来输入从而产生目标的文件,一个目标经常有几个依赖。
命令是 Make 执行的动作,一个规则可以含有几个命令,每个命令占一行。注意:每个
命令行前面必须是一个 Tab 字符,即命令行第一个字符是Tab。这是不小心容易出错的地方。
通常,如果一个依赖发生变化,则需要规则调用命令对相应依赖和服务进行处理从而更
新或创建目标。但是,指定命令更新目标的规则并不都需要依赖,例如,包含和目标‘clern’
相联系的删除命令的规则就没有依赖。
规则一般是用于解释怎样和何时重建特定文件的,这些特定文件是这个详尽规则的目
标。Make 需首先调用命令对依赖进行处理,进而才能创建或更新目标。当然,一个规则也
可以是用于解释怎样和何时执行一个动作,详见编写规则一章。
一个 Makefile 文件可以包含规则以外的其它文本,但一个简单的 Makefile 文件仅仅需
要包含规则。虽然真正的规则比这里展示的例子复杂,但格式却是完全一样。
2.2 一个简单的 Makefile 文件
一个简单的 Makefile 文件,该文件描述了一个称为文本编辑器(edit)的可执行文件
生成方法,该文件依靠 8 个 OBJ 文件(.o 文件),它们又依靠 8 个 C 源程序文件和 3 个头文
件。
在这个例子中,所有的 C 语言源文件都包含‘defs.h’ 头文件,但仅仅定义编辑命令
的源文件包含‘command.h’头文件,仅仅改变编辑器缓冲区的低层文件包含‘buffer.h’
头文件。
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.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 buffer.h
cc -c display.c
insert.o : insert.c defs.h buffer.h
cc -c insert.c
search.o : search.c defs.h buffer.h
cc -c search.c
files.o : files.c defs.h buffer.h command.h
cc -c files.c
utils.o : utils.c defs.h
cc -c utils.c
clean :
rm edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
我们把每一个长行使用反斜杠-新行法分裂为两行或多行,实际上它们相当于一行,这
样做的意图仅仅是为了阅读方便。
使用 Makefile 文件创建可执行的称为‘edit’的文件,键入:make
使用 Makefile 文件从目录中删除可执行文件和目标,键入:make clean
在这个 Makefile 文件例子中,目标包括可执行文件‘edit’和 OBJ 文件‘main.o’及
‘kdb.o’。依赖是 C 语言源文件和 C 语言头文件如‘main.c’和‘def.h’等。事实上,每
一个 OBJ 文件即是目标也是依赖。所以命令行包括‘cc -c main.c’和‘cc -c kbd.c’。
当目标是一个文件时,如果它的任一个依赖发生变化,目标必须重新编译和连接。任何
命令行的第一个字符必须是‘Tab’字符,这样可以把 Makefile 文件中的命令行与其它行分
别开来。(一定要牢记:Make 并不知道命令是如何工作的,它仅仅能向您提供保证目标的合
适更新的命令。Make 的全部工作是当目标需要更新时,按照您制定的具体规则执行命令。)
目标‘clean’不是一个文件,仅仅是一个动作的名称。正常情况下,在规则中‘clean’
这个动作并不执行,目标‘clean’也不需要任何依赖。一般情况下,除非特意告诉 make
执行‘clean’命令,否则‘clean’命令永远不会执行。注意这样的规则不需要任何依赖,
它们存在的目的仅仅是执行一些特殊的命令。象这些不需要依赖仅仅表达动作的目标称为假
想目标。详细内容参见假想目标;参阅命令错误可以了解 rm 或其它命令是怎样导致 make
忽略错误的。
2.3 make 处理 makefile 文件的过程
缺省情况下,make 开始于第一个目标(假想目标的名称前带‘.’)。这个目标称为缺省
最终目标(即 make 最终更新的目标,具体内容请看指定最终目标的参数一节)。
在上节的简单例子中,缺省最终目标是更新可执行文件‘edit’,所以我们将该规则设
为第一规则。这样,一旦您给出命令:
make
make 就会读当前目录下的 makefile 文件,并开始处理第一条规则。在本例中,第一条规则
是连接生成‘edit’,但在 make 全部完成本规则工作之前,必须先处理‘edit’所依靠的
OBJ 文件。这些 OBJ 文件按照各自的规则被处理更新,每个 OBJ 文件的更新规则是编译其源
文件。重新编译根据其依靠的源文件或头文件是否比现存的 OBJ 文件更‘新’,或者 OBJ 文
件是否存在来判断。
其它规则的处理根据它们的目标是否和缺省最终目标的依赖相关联来判断。如果
一些规则和缺省最终目标无任何关联则这些规则不会被执行,除非告诉 Make 强制执行(如
输入执行 make clean 命令)。
在 OBJ 文件重新编译之前,Make 首先检查它的依赖 C 语言源文件和 C 语言头文件
是否需要更新。如果这些 C 语言源文件和 C 语言头文件不是任何规则的目标,make 将不会
对它们做任何事情。Make 也可以自动产生 C 语言源程序,这需要特定的规则,如可以根据
Bison 或 Yacc 产生 C 语言源程序。
在 OBJ 文件重新编译(如果需要的话)之后,make 决定是否重新连接生成 edit
可执行文件。如果 edit 可执行文件不存在或任何一个 OBJ 文件比存在的 edit 可执行文件
‘新’,则 make 重新连接生成 edit 可执行文件。
文件 更新‘insert.o’文件,然 后重新连接生成 edit 可执行 文件。如果 我们修改 了
‘command.h’文件,然后运行 make,make 将会重新编译‘kbd.o’和‘command.o’文件,
然后重新连接生成 edit 可执行文件。
这样,如果我们修改了‘insert.c’文件,然后运行 make,make 将会编译‘insert.c’
2.4 使用变量简化 makefile 文件
在我们的例子中,我们在‘edit’的生成规则中把所有的 OBJ 文件列举了两次,这里再
重复一遍:
edit : main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
这样的两次列举有出错的可能,例如在系统中加入一个新的 OBJ 文件,我们很有可能在一个
需要列举的地方加入了,而在另外一个地方却忘记了。我们使用变量可以简化 makefile 文
件并且排除这种出错的可能。变量是定义一个字符串一次,而能在多处替代该字符串使用(具
体内容请阅读使用变量一节)。
在 makefile 文件中使用名为 objects, OBJECTS, objs, OBJS, obj, 或 OBJ 的变量代
表所有 OBJ 文件已是约定成俗。在这个 makefile 文件我们定义了名为 objects 的变量,其
定义格式如下:
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
然后,在每一个需要列举 OBJ 文件的地方,我们使用写为`$(objects)'形式的变量代替(具
体内容请阅读使用变量一节)。下面是使用变量后的完整的 makefile 文件:
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
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 buffer.h
cc -c display.c
insert.o : insert.c defs.h buffer.h
cc -c insert.c
search.o : search.c defs.h buffer.h
cc -c search.c
files.o : files.c defs.h buffer.h command.h
cc -c files.c
utils.o : utils.c defs.h
cc -c utils.c
clean :
rm edit $(objects)
2.5 让 make 推断命令
编译单独的 C 语言源程序并不需要写出命令,因为 make 可以把它推断出来:make 有一
个使用‘CC –c’命令的把 C 语言源程序编译更新为相同文件名的 OBJ 文件的隐含规则。例
如 make 可以自动使用‘cc -c main.c -o main.o’命令把‘main.c’编译 ‘main.o’。因
此,我们可以省略 OBJ 文件的更新规则。详细内容请看使用隐含规则一节。
如果 C 语言源程序能够这样自动编译,则它同样能够自动加入到依赖中。所以我们可在
依赖中省略 C 语言源程序,进而可以省略命令。下面是使用隐含规则和变量 objects 的完整
makefile 文件的例子:
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
main.o : defs.h
kbd.o : defs.h command.h
command.o : defs.h command.h
display.o : defs.h buffer.h
insert.o : defs.h buffer.h
search.o : defs.h buffer.h
files.o : defs.h buffer.h command.h
utils.o : defs.h
.PHONY : clean
clean :
-rm edit $(objects)
这是我们实际编写 makefile 文件的例子。(和目标‘clean’联系的复杂情况在别处阐
述。具体参见假想目标及命令错误两节内容。)因为隐含规则十分方便,所以它们非常重要,
在 makefile 文件中经常使用它们。
2.6 另一种风格的 makefile 文件
当时在 makefile 文件中使用隐含规则创建 OBJ 文件时,采用另一种风格的 makefile
文件也是可行的。在这种风格的 makefile 文件中,可以依据依赖分组代替依据目标分组。
下面是采用这种风格的 makefile 文件: