GNU make系列之写Makefile文件(1)

一.欢迎来到我的酒馆

在本章节介绍如何写Makefile文件。

二.Makefile包含了什么

2.1 Makefile包含了5种类型：显式的规则，隐式的规则，变量的定义，指令和注释。变量和指令会在之后的章节介绍。

显式的规则。一个显式的规则表明了如何重新编译一个或多个文件。先决条件列出了target所有依赖的文件，而且同样会提供一个配方用来创建或更新target。
隐式的规则。一个隐式的规则表明了如何重新编译一些文件，一个隐式的规则描述了一个target如何依赖一个文件，并且提供一个配方来创建或更新一个target。
变量的定义。可以对一个变量指定文本字符串，并且在稍后的文本中替换这个文本字符串。
指令。当make程序读取Makefile的时候，根据指令执行特定的操作，这些指令包括：
- 读取另外一个Makefile文件。
- 决定是否不执行一部分Makefile。
- 从包含多行的逐字字符串定义变量。
“#” 表示注释所在行。注释行的剩余部分不会被执行。

#这是单行注释。
 
#这是 \
 多行 \
 注释 \

2.2 分割长的行
Makefile使用基于行的语法，其中换行符是特殊的，用来标记语句的结尾。GNU make对于一行语句的长度没有限制，这取决于你电脑的内存大小。
但是，如果一行语句太长的话，这很难读懂。因此，你可以格式化Makefile，增强Makefile的可读性。可以在换行的末尾加一个 " \ " 反斜杠。
2.3 不添加空格来分割行
如果你想要拆分一行但不希望添加空格，可以使用一个技巧：用$符号，反斜杠和换行符替换反斜杠。

var := one$\
		word

在make程序移出反斜杠重新组成一行，它和下面的是等效的：

var := one$ word

make程序会执行变量。变量引用 “$” 会引用一个空格符 " " 。给出最终版本，等效于：

var := oneword

2.4 Makefile可以取哪些名字
      默认的，当make程序寻找Makefile的时候，它会按照：GNUmakefile，makefile，Makefile的顺序来找。通常，你可以把Makefile文件叫成makefile或Makefile，但是推荐将使用Makefile这个名字，因为它在罗列的目录列表里更靠前。GNUmakefile这个名字不推荐使用，当一个makefile文件不能被其他版本的make程序执行的时候，你可以将一个makefile文件指定为GNU make。其它版本的make程序只会搜索名字为makefile，Makefile的文件，而不会使用名字为GNUmakefile。
      如果make程序没有找到名字为makefile，Makefile，GNUmakefile，那么make程序不会做任何操作。因此你必须通过使用命令行参数指定一个目标，之后make程序会尝试重新编译。
      如果你想要使用一个不好理解的名字作为Makefile的名字，你可以使用" -f " 或 “–file” 指定特定的Makefile文件。“-f name"或”–file=name" 会告诉make程序把一个文件当成Makefile文件来读取。如果你使用了一个或多个"-f" “–file” 选项，你可以指定多个Makefile文件。所有的Makefile都按指定的顺序有效链接。如果你使用了参数：“-f " 或” --file "，这个时候make程序不会自动检查默认的名字，如makefile，Makefile和GNUmakefile。

当一个Makefile的文件名字，不是makefile、Makefile、GNUmakefile的时候，在当前目录下执行make命令，会报：

make: *** No targets specified and no makefile found.  Stop.

这个时候，你可以使用参数选项：" -f “、” --file "

make -f file_name

或

make --file=file_name

三.引入其它的Makefile文件

include指令告诉make程序暂停读取当前的Makefile文件，并读取一个或多个其它Makefile文件，然后再继续。这个include指令在Makefile文件中，如下：

	include filename ...

filename可以是一个shell文件，如果filename是空的，不会引入任何文件且不会打印错误。
在include指令的开头不能敲tab键，因为如果一行的开头敲了一个tab键，make程序会把这一行当成是一个配方（recipe）。在include和filename之间需要敲一个空格，filename之间也需要敲一个空格，include所在的行的多余的空格不会被执行。"#"符号表示注释一行。
例如，假定你有3个.mk文件，a.mk，b.mk，和c.mk，下面的例子：

include *.mk

等效于：

include a.mk b.mk c.mk

      当make程序执行include指令的时候，它会暂停读取Makefile文件，转而读取每个被引入的文件，当读取引入的文件完成后，make程序会继续在上次暂停的地方读取Makefile文件。
      include指令的一个引用场景是：当有多个不同的应用程序，在不同的目录有不同的Makefile文件需要使用一组共同的变量。另一个应用场景是：当你想要从源文件自动生成先决条件。
      当GNU make在MS-DOS/MS-Windows支持的路径下编译时，如果这个指定的名字不以斜杆（" / “）或盘符（ C: ）开始，并且这个文件不在当前目录。首先，make程序会从” -I “或” --include-dir " 目录下搜索，然后会按顺序搜索：

prefix/include(/usr/local/include), /usr/gnu/include, /usr/local/include,/usr/include.

下面演示include指令：
继续使用cJSON项目为例子，如果还没有下载，点击这里下载cJSON源程序
下载后解压文件：

tar -zxvf cJSONSourceFiles.tar.gz

进入cJSON目录，文件如下：
在这里插入图片描述
在当前目录新建一个Makefile文件，内容如下：

#include指令用于引入一个文件。
include tmp.mk
#objects=cJSON.o test.o

all: test

test: ${objects}
	cc -W -Wall -o test ${objects} -lm
cJSON.o: cJSON.h

test.o:

.PHONY: clean
clean:
	rm -rf ${objects} test

在目录：

/usr/local/include

下新建一个文件，名为tmp.mk，tmp.mk的内容如下：

objects=cJSON.o test.o

在这里插入图片描述
现在回到cJSON目录，也就是Makefile文件所在的目录，执行命令：

make

输出：

cc    -c -o cJSON.o cJSON.c
cc    -c -o test.o test.c
cc -W -Wall -o test cJSON.o test.o -lm

在当前目录下生成了一个可执行文件：test。可以看到在Makefile里使用了include指令，引入了一个文件：tmp.mk，make程序在读取Makefile文件的时候，当读取到include指令的时候，他会去目录 “/usr/local/include” 找 "tmp.mk"文件，并把tmp.mk文件里面的内容导入到Makefile文件中。
在使用make程序的时候，可以指定要包含的目录：

make -I /usr/local/include
或：
make --include-dir /usr/local/include

变量：.INCLUDE_DIRS包含了一组目录，这组目录显示了make程序默认会去哪些目录引入文件。通过在执行make程序的时候指定include目录，可以使用选项 “-I”，这样可以避免make程序去默认目录找include文件。如果在默认目录里找不到要包含的文件，这时并不会报错。它会继续处理包含include的makefile文件。当make程序读取makefile文件完成后，make程序会尝试重新编译旧的、需要生成的文件。仅仅在make程序不能在makefile中找到一个执行单元来编译文件的时候，或者找到一个规则时但没有配方，make程序才会判断这个缺失的makefile有错误。
如果你想让make程序忽略错误，当引入的包含文件不存在时或不能执行重新编译时，可以使用：

-include filenames

例如，当tmp.mk文件不存在时，这时候引入tmp.mk文件，

include tmp.mk

会报：

Makefile:2: tmpq.mk: No such file or directory
make: *** No rule to make target `tmpq.mk'.  Stop.

使用 “-include tmp.mk” 就会忽略这个错误。为了和其它版本的make程序兼容，可以使用 “sinclude”。

四.MAKEFILES变量

      如果定义了环境变量MAKEFILES，make程序会把它的值作为一个额外的makefile列表，make会首先读取它。这个功能和Include指令很像，它会搜索不同的目录寻找这些makefile文件。而且，默认目标永远不会从这些makefile中获取，如果罗列在MAKEFILES里的文件没有找到也不会报错。
      MAKEFILES的主要用途是在递归调用make的时候进行通信。通常不希望在顶级调用make之前设置环境变量，因为通常最好不要在外部把makefile搞混淆。然而，如果你在运行make程序的时候没有指定makefile文件，MAKEFILES里罗列的makefile文件在内置隐式规则很有用，例如定义搜索路径。
      一些用户会尝试着在登录的时候自动设置MAKEFILES环境变量。make程序会按照预期的步骤执行。但是这并不是一个好的解决方案，因为如果makefile文件是由其它人运行的话，他将会失效。因此在makefile文件里写include指令会更好。