How to Use Makefile

目录

• 几个常识
• Makefile 介绍
• Makefile 的细节
• 使用变量和函数
• make 的运行
• 隐含规则
• 使用 make 更新函数库文件

一、几个常识

Makefile 写好编译策略后，使用 make 实现自动化编译

从程序到可执行文件：

graph LR
s[source file]--compile-->obj[object file]
obj--link-->p[Program]

在 link 的过程中，有时候需要很多的链接函数和全局变量。在链接过程中由于目标文件（Object File）太多，所以我们将这些文件打包成，Windos 中为「库文件」（ .lib，Library File），在 UNIX 中为 Archive File（.a）。

二、 Makefile 介绍

一般思路：

• 准备好源文件
• 规定编译的规则，例如：
  • 若没有编译过，则全部源文件编译链接
  • 若其中几个源文件被修改过，则只编译被修改的源文件，再进行连接
  • 如果头文件改变了，那么引用新的头文件，并链接
  • …

1、Makefile 的规则

# Example Rule:
target... : prerequisites ...
		command
		...
		...

target ：目标文件，可以是 Objetc File 或者可执行文件，还可以是一个标签（Label）

prerequisites ：先决条件，可以理解为生成 target 所需要的原料（文件 or 目标）

command ：执行 make 需要执行的命令。（任意的 shell 命令）

Makefile 规则：

实际上是一个文件依赖关系， target 依赖于 prerequisite 的文件，其中的生成的规则策略由 command 给出。

定义好依赖关系后，后续的那一行定义如何生成目标文件的操作系统命令，注意要以 Tab 开头。make 会比较 target 和 prerequisites 文件的修改日期，如果 prerequisites 日期比 target 要新或者 target 不存在的话，make 才会执行后续命令。

2、make 如何工作的？

# 定义我们的第一个 目标文件 策略, all 依赖于 main.o command.o display.o
# \ 为上下行连接符
# cc 执行链接生成 program 的可执行程序
all: main.o command.o \
	display.o
  cc -o program main.o command.o display.o
  
# 由于 all 中的先决条件依赖于它们的源文件，
# 因此我们需要再定义一下各个先决条件的生成策略
main.o: main.c main.h
		cc -c main.c
command: command.c command.h
		cc -c command.c
		
# clean 功能用来删除生成的 *.o 和可执行文件。
clean: 
		rm program main.o command.o

在默认方式下，只输入 make 命令，那么：

• make 会在当前目录下寻找「Makefile」或者「makefile」文件
• 如果找到，make 继续寻找文件中的第一个目标文件 target， 在上面的例子中，make 会找到 all 这个目标，并把这个文件作为最终的的目标文件
• 如果 all 依赖的 .o 文件不存在，那么 make 会执行后面定义的策略生成 all 的先决条件。
• 如果 all 依赖的 .o 文件存在， make 会先检查一下目标文件和它们的先决条件的修改日期，如果先决条件更新了，那么 make 会更新生成新的目标文件。
• make 会一层一层去寻找文件的依赖关系，直到把第一个终极目标文件整出来为止。
• ⚠️ 值得注意的是，clean 并没有出现在终极目标 all 的策略中，因此只输入 make 的命令是不会执行 clean 的功能。我们可以采用 make clean 来执行这个策略。

3、Makefile 中使用变量

# 延用上面的例子
all: main.o command.o \
	display.o
  cc -o program main.o command.o display.o  
main.o: main.c main.h
		cc -c main.c
command: command.c command.h
		cc -c command.c
clean: 
		rm program main.o command.o

在这个 Makefile 中，我们可以看到我们把我们需要的先决条件全部列出来，这个在文件不多时并不复杂，但是如果遇到文件量较多的工程时，采用这方式可能会让我们漏掉一两个文件，从而导致编译失败。为了 makefile 的易维护，在 makefile 中我们可以使用变量。

「Makefile 的变量其实也就是一个字符串，理解成 C 语言中的宏定义可能会更好」

比如我们将所有的 .o 文件声明为一个变量 objects ，我们可以在 makefile 的一开始就这样定义好：

objects = main.o command.o display.o

这样，我们就可以很方便的在 makefile 中采用 $(objects) 的方式来使用这个变量了，下面我们改良一下我们的例子：

# 定义变量 objects
objects = main.o command.o display.p
# 编写策略
all : $(objects)
		cc -o program $(objects)
main.o : main.c main.h
		cc -o main.c
command.o : command.c command.h
		cc -o command.c 
display.o : display.c display.o
		cc -o display.c
		
clean : 
		rm progam $(objects)

这个时候若有新的 .o 文件加入，我们只需要修改 objects 变量以及新增目标策略jiukeyiile。

4、让 make 自动推导

GNU 的 make 很强大，它可以自动推导文件以及文件依赖关系后面的命令，于是我们没有必要在每一个 .o 文件后面都写上类似的命令。 make 会自动识别，自己推导命令。

下面我们继续将我们的例子优化：

objects = main.o command.o display.o
all : $(objects)
		cc -o program $(objects)
		
main.o: main.h
command.o: command.h
display.o: display.h

.PHONY : clean
clean :
		rm program $(objects)

这种方法，也就是 make 的「隐晦规则」。 .PHONY 表示 clean 是一个伪目标文件。

6、清空目标文件的规则

每个 Makefile 中都应该写一个清空目标文件 （ .o 和执行文件 ）的规则，这不仅便于重新编译，也很利于保持文件的清洁。可以说是「程序猿」的一种「修养」，一般的风格都是：

clean:
		rm program $(objects)

更稳健的做法是：

.PHONY: clean
clean:
		-rm program $(objects)

这里又出现了 .PHONY ，这里表示 clean 是一个「伪目标」，在 rm 命令前面加一个 - 表示：也许某些文件出现问题，但是不用在意，继续执行。

冷知识：一个不成文的规定：「clean 从来都是放在 Makefile 文件的最后。」

三、Makefile 的细节

1、Makefile 里有什么？

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

1）显示规则：如何生成一个或者多个目标文件，这个是由 Makefile 的书写者明显指出的，包括要生成的文件，文件的依赖文件以及生成的命令。

2）隐晦规则：依靠 make 的自动推导空能，我们可以简略书写 Makefile，这个是由 make 所支持的

3）变量定义：在 Makefile 中我们要定义一系列的变量，可以把这些变量当成 C 语言中的 宏定义 来理解。

4）文件指示：文件指示包含了三个部分：

• 第一部分是在 Makefile 中引用另一个 Makefile，就像 C 语言中的 include 一样；
• 第二部分是根据某些情况制定 Makefile 中的有效部分，就像 C 语言中的预编译 #if 一样；
• 第三部分是定义一个多行的命令。
• 注释： Makefile 中只有行注释，采用 # 开头。

2、Makefile 的文件名

默认情况下，make 命令会在当前的目录下按顺序寻找文件名为 “GNUmakefile”、“makefile”、“Makefile"的文件，找到了解释这个文件。在这三个文件名中，最好使用"Makefile"这个文件名。（比较显目和好看）最好不要用"GNUmakefile”，这个文件是 GNU 的 make 识别的。有些编译器只支持小写的"makefile"，但基本上来说大部分 make 都支持 “Makefile” 和 “makefile” 两种文件名。

同样，如果需要用别的文件名来写 Makefile，比如 “Make.Linux”, “Make.Solaris”, "Make.mac"等。可以使用：

make -f Make.Linux 
make -file Make.AIX

3、引用其他的 Makefile

在 Makefile 中使用 include 关键字可以把别的 Makefile 包含进来。

include <FileName> # FileName 可以是当前操作系统 Shell 的文件模式

文件名：如果文件都诶呦指定绝对路径或是相对路径， make 会在当前目录下首先须按照，如果当前目录下没有找到，make 还会在下面几个目录下寻找：

# 1 如果 make 命令有 “-I” 或 "——include-dir" 参数，那么 make 就会在这个参数所制定的目录下去寻找。
make -I <dir>
# 2 如果目录 /include (一般是： /usr/local.bin 或 /usr/include) 存在的话，make 也会去寻找。

4、环境变量 MAKEFILES

如果在当前环境中定义了环境变量 MAKEFILES，那么，make 会把这个变量中的值做一个类似于 include 的动作。这个变量中的值是其他的 Makefile，并用空格分隔。

与 include 不同的是，从这个环境变量中引入的 Makfile 的“目标”不会起作用，如果环境变量中的定义的文件发现错误，make 也会不理。

不建议使用这个环境变量，一旦定义 MAKEFILES 环境变量，其他的 make 均会收到影响。这一点也可以用来检查错误，如果有一天你突然发现你的 Makefile 执行结果很离谱，不妨看看这个 MAKEFILES 环境变量是不是被定义了。

5、make 的工作方式

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

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

6、Makefile 书写规则

规则包括两个部分：一个是依赖关系，一个是生成目标方法

在 Makefile 中，规则的顺序是十分重要的，因为对于一个 Makefile 来说，只有一个终极目的：第一个目标文件的生成。

# 规则语法
# target : prerequisites
#				command...
main.o : main.c main.h #  main 模块
		cc -o main.c

在生成过程中，make 都会检测 target 和 prerequisites 的时间，如果 prerequisites 更新了，那么 make 才会进行生成，反之不进行生成。

如果命令太长，可以使用反斜杠 \ 作为换行符。

一般来说，make 会以 UNIX 的标准 Shell，也就是 /bin/sh 来执行命令。

7、在规则中使用通配符

如果我们想定义一系列比较类似的文件，我们可以采用通配符。make 中支持三个通配符 *, ?, [...]

~ 表示当前用户的 $HOME 目录下的目录。

* 表示任意，比如要所有的 .c 文件，可以写 *.c 来实现。

8、文件搜索

在一些大的工程中，有大量的温元件，我们通常的做法是把这些许多的源文件分类，并存放在不同的目录中。所以，当 make 需要去寻找文件的依赖关系时，我们可以在文件前加上路径。最好的方法是告诉 make 一个路径，让它自己去找。

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

VPATH = src:../headers

上面定义的两个目录，“src” 和 “…/headers”，make 会按照这个顺序进行搜索，目录由「冒号」分隔。

还可以使用 make 的关键字 “vpath” （它不是变量，只是一个关键字，注意全小写）

# 符合模式 <pattern> 的文件制定搜索目录 <directories>
vpath <pattern> <directories>
# 清除符合模式 <pattern> 的文件的搜索目录
vpath <pattern>
# 清楚所有已经被设置好的文件搜索目录
vpath

<pattern> 需要包含 “%” 字符。"%" 的意思是匹配零或若干字符，例如，"%.h" 表示所有以 “.h” 结尾的文件。 <pattern> 制定了要搜索的文件集

<directories> 则制定了文件集的搜索目录。

# 要求 make 在 "../headers" 目录下搜索所有以 ".h" 结尾的文件。
vpath %.h ../headers

9、伪目标

上面的例子中我们提到了.PHONY ：clean 中的 clean 是一个伪目标，这里来解释一下。

在 Makefile 中的我们并不需要生成一个 clean 的文件，所以「伪目标」并不是一个文件，只是一个标签（Label）。由于定义了它是一个伪目标，因此 make 无法生成它的依赖关系和决定它是否要执行。

10、多个目标

Makefile 的规则中的目标可以不止一个，其支持多目标，有可能我们的多个目标同时依赖于一个文件，并且其生成的命令大体类似。于是我们就能其合并起来。这里我们可以使用自动化变量$@。

outputA ouputB : text.g
		generate text.g -$(subst output,,$@) > $@
# 等价于
outputA : text.g
		generate text.g -big > outputA
outputB : text.g
		generate text.g -little >outputB

其中 -$(subst output,,$@) 中的 $ 表示执行一个 Makefile 的函数，函数名为 subst，后面的为参数。$@ 表示目标的集合，就像一个数组，$@ 依次取出目标，并执行命令。

11、静态模型

12、自动生成依赖性

我们之前已经提到了 make 的自动推导功能，但是仅仅是自动推导功能，在修改单个目标文件的头文件或者源文件时，仍需要小心的修改 Makefile 文件。这是一个很缺乏维护性的过程。为此，我们可以使用 C/C++ 编译的一个功能。

大多数 C/C++ 编译器都支持一个 “-M” 的选项，即自动寻找源文件中包含的头文件，并自动生成一个依赖关系。

cc -M main.c
# 等价于
main.o: main.c main.h

这样利用编译器自动生成的依赖关系，我们就不比手动书写若干文件的依赖关系。

注意：如果使用 GNU 的 C/C++ 编译器，得使用 “——MM” 参数，不然 “-M” 参数会把一些标准库的头文件也包含进来。

13、嵌套执行 make

---

后面的暂时用不上了，写个框架以后填坑 😄

四、使用变量

参考前面的部分就差不多了

环境变量、目标变量、模式变量

五、使用函数

六、make 的运行

七、隐含规则

八、使用 make 更新函数库文件

一个函数库文件由多个文件组成。你可以以如下的格式制定函数库文件及其组成：

archive(member)

注意，这个并不是一个命令，而是一个目标和依赖的定义。一般来说，这种用法是为了 ar 命令来服务的：

foolib(hack.o):hack.o
ar cr foolib hack.o
foolib(*.o):.....

1、函数库成员的隐含规则

当 make 搜索一个目标的隐含规则时，一个特殊的特性时，如果这个目标是 “a(m)” 形式的，其会把目标变成 “(m)”。如果此时，我们的成员都是 “%.o” 的模式定义，并且如果我们使用 “make foo.a(bar.o)” 的形式调用 Makefile 时，隐含规则会去找 “bar.o” 的规则，如果没有定义 bar.o，那么内建隐含规则生效，make 会去寻找 bar.c 文件来生成 bar.o，如果找得到的话，make 执行的命令大致如下：

cc -c bar.c -o bar.o
ar r foo.a bar.o
rm -f bar.o

2、后缀规则

3、注意事项

---

参考自 CSDN 论坛：博客地址