Makefile 使用总结

Makefile 是和 make 命令一起配合使用的.

很多大型项目的编译都是通过 Makefile 来组织的, 如果没有 Makefile, 那很多项目中各种库和代码之间的依赖关系不知会多复杂.

Makefile的组织流程的能力如此之强, 不仅可以用来编译项目, 还可以用来组织我们平时的一些日常操作. 这个需要大家发挥自己的想象力.

非常感谢 gunguymadman_cu 提供如此详尽的Makefile介绍, 这正是我一直寻找的Makefile中文文档.

Makefile基本格式如下:

其中,

target        - 目标文件, 可以是 Object File, 也可以是可执行文件

prerequisites - 生成 target 所需要的文件或者目标

command       - make需要执行的命令 (任意的shell命令), Makefile中的命令必须以 [tab] 开头

显示规则 :: 说明如何生成一个或多个目标文件(包括 生成的文件, 文件的依赖文件, 生成的命令)

隐晦规则 :: make的自动推导功能所执行的规则

变量定义 :: Makefile中定义的变量

文件指示 :: Makefile中引用其他Makefile; 指定Makefile中有效部分; 定义一个多行命令

注释     :: Makefile只有行注释 "#", 如果要使用或者输出"#"字符, 需要进行转义, "\#"

读入主Makefile (主Makefile中可以引用其他Makefile)

读入被include的其他Makefile

初始化文件中的变量

推导隐晦规则, 并分析所有规则

为所有的目标文件创建依赖关系链

根据依赖关系, 决定哪些目标要重新生成

执行生成命令

规则主要有2部分: 依赖关系 和 生成目标的方法.

语法有以下2种:

或者

*注* command太长, 可以用 "\" 作为换行符

*     :: 表示任意一个或多个字符

?     :: 表示任意一个字符

[...] :: ex. [abcd] 表示a,b,c,d中任意一个字符, [^abcd]表示除a,b,c,d以外的字符, [0-9]表示 0~9中任意一个数字

~     :: 表示用户的home目录

当一个Makefile中涉及到大量源文件时(这些源文件和Makefile极有可能不在同一个目录中),

这时, 最好将源文件的路径明确在Makefile中, 便于编译时查找. Makefile中有个特殊的变量 VPATH 就是完成这个功能的.

指定了 VPATH 之后, 如果当前目录中没有找到相应文件或依赖的文件, Makefile 回到 VPATH 指定的路径中再去查找..

VPATH 使用方法:

vpath <directories>            :: 当前目录中找不到文件时, 就从<directories>中搜索

vpath <pattern> <directories>  :: 符合<pattern>格式的文件, 就从<directories>中搜索

vpath <pattern>                :: 清除符合<pattern>格式的文件搜索路径

vpath                          :: 清除所有已经设置好的文件路径

其中 = 和 := 的区别在于, := 只能使用前面定义好的变量, = 可以使用后面定义的变量

测试 =

测试 :=

作用是使 Makefile中定义的变量能够覆盖 make 命令参数中指定的变量

语法:

override <variable> = <value>

override <variable> := <value>

override <variable> += <value>

下面通过一个例子体会 override 的作用：

作用是使变量的作用域仅限于这个目标(target), 而不像之前例子中定义的变量, 对整个Makefile都有效.

<target ...> :: <variable-assignment>

<target ...> :: override <variable-assignment> (override作用参见 变量覆盖的介绍)

示例:

Makefile 中书写shell命令时可以加2种前缀 @ 和 -, 或者不用前缀.

3种格式的shell命令区别如下:

不用前缀 :: 输出执行的命令以及命令执行的结果, 出错的话停止执行

前缀 @   :: 只输出命令执行的结果, 出错的话停止执行

前缀 -   :: 命令执行有错的话, 忽略错误, 继续执行

伪目标并不是一个"目标(target)", 不像真正的目标那样会生成一个目标文件.

典型的伪目标是 Makefile 中用来清理编译过程中中间文件的 clean 伪目标, 一般格式如下:

语法: include <filename>  (filename 可以包含通配符和路径)

写 Makefile 的时候, 需要确定每个目标的依赖关系.

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

比如, 下面命令显示内核源码中 virt/kvm/kvm_main.c 中的依赖关系

Makefile的退出码有以下3种：

0 :: 表示成功执行

1 :: 表示make命令出现了错误

2 :: 使用了 "-q" 选项, 并且make使得一些目标不需要更新

默认执行 make 命令时, GNU make在当前目录下依次搜索下面3个文件 "GNUmakefile", "makefile", "Makefile",

找到对应文件之后, 就开始执行此文件中的第一个目标(target). 如果找不到这3个文件就报错.

非默认情况下, 可以在 make 命令中指定特定的 Makefile 和特定的 目标.

示例：

make 的参数有很多, 可以通过 make -h 去查看, 下面只介绍几个我认为比较有用的.

参数

含义

--debug[=<options>]

输出make的调试信息, options 可以是 a, b, v

-j --jobs

同时运行的命令的个数, 也就是多线程执行 Makefile

-r --no-builtin-rules

禁止使用任何隐含规则

-R --no-builtin-variabes

禁止使用任何作用于变量上的隐含规则

-B --always-make

假设所有目标都有更新, 即强制重编译

这里只列一个和编译C相关的.

编译C时，<n>.o 的目标会自动推导为 <n>.c

下面只列出一些C相关的

变量名

RM

rm -f

AR

ar

CC

cc

CXX

g++

ARFLAGS

AR命令的参数

CFLAGS

C语言编译器的参数

CXXFLAGS

C++语言编译器的参数

示例: 下面以 CFLAGS 为例演示

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

自动变量

$@

目标集合

$%

当目标是函数库文件时, 表示其中的目标文件名

$<

第一个依赖目标. 如果依赖目标是多个, 逐个表示依赖目标

$?

比目标新的依赖目标的集合

$^

所有依赖目标的集合, 会去除重复的依赖目标

$+

所有依赖目标的集合, 不会去除重复的依赖目标

$*

这个是GNU make特有的, 其它的make不一定支持

在 Makefile 初级语法中已经提到过引用其它 Makefile的方法. 这里有另一种写法, 并且可以向引用的其它 Makefile 传递参数.

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

示例: (用export传递参数)

*补充* export 语法格式如下:

export variable = value

export variable := value

export variable += value

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

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

示例: ifeq的例子, ifneq和ifeq的使用方法类似, 就是取反

示例: ifdef的例子, ifndef和ifdef的使用方法类似, 就是取反

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

函数调用语法如下:

<function> 是函数名

<arguments> 是函数参数

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

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

返回: 替换过的字符串

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

返回: 排序后的字符串

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

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

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

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

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

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

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

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

返回: 单词个数

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

返回: 连接后的字符串

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

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

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

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

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

$(origin <variable>)

返回值有如下类型:

类型

undefined

<variable> 没有定义过

default

<variable> 是个默认的定义, 比如 CC 变量

environment

<variable> 是个环境变量, 并且 make时没有使用 -e 参数

file

<variable> 定义在Makefile中

command line

<variable> 定义在命令行中

override

<variable> 被 override 重新定义过

automatic

<variable> 是自动化变量

$(shell <shell command>)

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

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

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

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

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

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

如果有过在Linux上, 从源码安装软件的经历的话, 就会对 make clean, make install 比较熟悉.

像 clean, install 这些伪目标, 广为人知, 不用解释就大家知道是什么意思了.

下面列举一些常用的伪目标, 如果在自己项目的Makefile合理使用这些伪目标的话, 可以让我们自己的Makefile看起来更专业, 呵呵 :)

伪目标

all

所有目标的目标，其功能一般是编译所有的目标

clean

删除所有被make创建的文件

install

安装已编译好的程序，其实就是把目标可执行文件拷贝到指定的目录中去

print

列出改变过的源文件

tar

把源程序打包备份. 也就是一个tar文件

dist

创建一个压缩文件, 一般是把tar文件压成Z文件. 或是gz文件

TAGS

更新所有的目标, 以备完整地重编译使用

check 或 test

一般用来测试makefile的流程

本文转自wang_yb博客园博客，原文链接：http://www.cnblogs.com/wang_yb/p/3990952.html，如需转载请自行联系原作者