makefile介绍及语法

参考文档: https://xiazemin.github.io/MyBlog/linux/2018/09/13/makefile.html

Make程序最初设计是为了维护C程序文件防止不必要的重新编译。在使用命令行编译器的时候，修改了一个工程中的头文件，如何确保包含这个头文件的所有文件都得到编译？现在10机的版本生成是使用批处理程序，编译那些文件依赖于程序的维护者，在模块之间相互引用头文件的情况下，要将所有需要重新编译的文件找出来是一件痛苦的事情；在找到这些文件之后，修改批处理进行编译。实际上这些工作可以让make程序来自动完成，make工具对于维护一些具有相互依赖关系的文件特别有用，它对文件和命令的联系（在文件改变时调用来更新其它文件的程序）提供一套编码方法。Make工具的基本概念类似于Proglog语言，你告诉make需要做什么，提供一些规则，make来完成剩下的工作。 make工作自动确定工程的哪部分需要重新编译，执行命令去编译它们。虽然make多用于C程序，然而只要提供命令行的编译器，你可以将其用于任何语言。实际上，make工具的应用范围不仅于编程，你可以描述任和一些文件改变需要自动更新另一些文件的任务来使用它。

规则简介

makefile中的规则是这样的：

TARGET … : DEPENDENCIES … 
<tab> COMMAND
...

说明:

  • 目标(TARGET): 程序产生的文件，如可执行文件和目标文件； 目标也可以是要执行的动作，如clean。
  • 依赖(DEPENDENCIES): 是用来产生目标的输入文件，一个目标通常依赖于多个文件。
  • 命令(COMMAND): 是make执行的动作，一个可以有多个命令，每个占一行。 注意：每个命令行的起始字符必须为TAB字符！

有依赖关系规则中的命令通常在依赖文件变化时负责产生target文件，make执行这些命令更新或产生target。规则可以没有依赖关系，如包含target “clean”的规则。 规则解释如何和何时重做该规则中的文件，make根据依赖关系执行产生或更新目标；规则也说明如何和何时执行动作。有的规则看起来很复杂，但都符合上述模式。

make工作原理

缺省make从第一个target开始（第一个非 ’.’ 开始的target），这称作缺省目标。

Makefile中包含五种内容：显式规则，隐式规则，变量定义，指令（directive）和注释。

  1. 显式规则：描述如何生成规则的目标，它列出了目标依赖的文件，指定了产生或更新目标的命令
  2. 隐式规则：描述如何生成基于文件名的一类文件，说明目标可能依赖于和其文件名类似的文件，指定了相应的命令。
  3. 变量定义:定义一个变量。
  4. 指令：类似与编译器的伪指令，包含：指示make读入另一个makefile，决定是否忽略makefile中的一部 分。
  5. 注释：以‘#’开始直到行末，除非遇到续行符号。在define和命令中不能有注释，其它情况下注 释可出现在任何地方。

wildcard、notdir、patsubst的意思：

  • wildcard : 扩展通配符
  • notdir ： 去除路径
  • patsubst ：替换通配符

当你需要在一些源文件改变后运行或更新一个任务时，通常会用到 make 工具。make 工具需要读取一个 Makefile（或 makefile）文件，在该文件中定义了一系列需要执行的任务。你可以使用 make 来将源代码编译为可执行程序。大部分开源项目会使用 make 来实现最终的二进制文件的编译，然后使用 make install 命令来执行安装。

典型的规则语法

目标: 预置条件

目标可以是一个基于预置条件（源代码）的二进制文件。另一方面，预置条件也可以是依赖其他预置条件的目标。

目标并不要求是一个文件，也可以只是步骤的名字，就如我们的例子中一样。我们称之为“伪目标”。 当 make 被执行时，整条指令 echo “Hello World” 都被显示出来，之后才是真正的执行结果。如果不希望指令本身被打印处理，需要在 echo 前添加 @。

示例:

say_hello: 
	echo "Hello World"

输出为:

echo "Hello World"
Hello World

示例:

say_hello: 
	@echo "Hello World"

输出:

Hello World

因为Makefile 中的第一个目标为默认目标。通常情况下会调用默认目标，这就是你在大多数项目中看到 all 作为第一个目标而出现。all 负责来调用它他的目标。我们可以通过 .DEFAULT_GOAL 这个特殊的伪目标来覆盖掉默认的行为。

在 Makefile 文件开头增加 .DEFAULT_GOAL： make 会将 generate 作为默认目标：

.DEFAULT_GOAL := generate

示例:

.DEFAULT_GOAL := test1

test:
       echo "test"

test1: 
       echo "test1"

.DEFAULT_GOAL 伪目标仅能定义一个目标。这就是为什么很多 Makefile 会包括 all 这个目标，这样可以调用多个目标。

伪目标

.PHONY 用来定义这些不是文件的目标。make 会默认调用这些伪目标下的步骤，而不去检查文件名是否存在或最后修改日期。

shell 命令

每个目标都可以具有与其关联的一系列 shell 命令，这些命令通常用来创建目标。此脚本中的每一条命令都必须以制表符开始。虽然任何目标都能够显示在相关性行上，但除非使用 :: 操作符，否则这些相关性中只有一个能够通过创建脚本来跟随。

已知phony 目标并非是由其它文件生成的实际文件，make 会跳过隐含规则搜索。这就是声明phony 目标会改善性能的原因，即使你并不担心实际文件存在与否。

如果命令行的第一个或前两个字符是 @ (at 符号)、-（连字符）和 +（加号）这几个符号之一或全部，那么将特别处理该命令，如下：

  • @使命令在被执行前不被回显。
  • - 使任何命令行的任何非零退出状态都被忽略。
  • + 使命令行可以通过指定 -n、-q 或 -t 选项来执行。

makefile名字

缺省情况下，make以下列名字查找makefile：GNUmakefile，makefile和Makefile（注意大小写）。

通常你的makefile应叫做’makefile’或’Makefile’。’GNUmakefile’不推荐，除非你的makefile是为GNU的make定制的，其它的make不认为该名字是一个makefile的名字。 如果你使用非标准命名的makefile，必须用命令开关’-f ’ 或 ’–file’。参数’-f NAME’或’–file NAME’告诉make读入NAME作为makefile。

如果使用多个该开关，所有的文件将按顺序连接起来。如果使用该选项，标准的makefile名字不会自动检测。

包含

include指令告诉make暂停处理余下的内容，读入其它makefile。

语法如下：

include FILENAMES …

这一行起始可以有空格，但TAB字符不允许。

如果文件名包含变量或函数，这些将被扩展。

MAKEFILE变量

如果环境变量MAKEFILE已定义，make认为它的值是一系列空格隔开的文件名，这些文件在处理其它makefile前被make程序读入。 这类似于include指令；这些文件中的目标不会影响缺省目标，而且如果文件未找到的话，make并不认为是错误。这个变量的主要用途是递归引用make程序时通讯。

?如何重新生成makefile

有时候makefile是从其它文件生成的，比如RCS或SCCS文件。如果makefile是由其它文件生成的，需要make读入最新版本的makefile。在读入所有makefile之后，make认为每个makefile是一个目标，试图去更新它；如果makefile中有一条如何更新它的规则，或者有适用的隐式规则，需要的更新会进行。所有的makefile检查完之后，如果有的改变了，make重新开始再读入（make会试图再做更新，但通常不会再改变了，因为已经是最新的了）。

如果一个文件使用双冒号规则，提供了命令但没有依赖关系，文件始终会被更新。在makefile的情况下，如果makefile双冒号规则，提供了命令但没有依赖关系，这样makefile始终会重新生成，这会导致循环：make只是在不断更新makefile，却不干活。为避免这种情况，make不会重新生成那些只有命令没有依赖关系的双冒号规则的makefile。 如果没有使用’-f’或’–file’选项，make会尝试缺省的makefile文件名。和指明’-f’或’–file’选项不同，make不能确定这些文件是否应当存在。然而，如果缺省makefile不存在但可以通过运行make规则生成，你可能希望这些规则被运行使得makefile可以使用。因此，如果没有缺省makefile，make试图按照makefile名查找的顺序生成它，直到成功或名字用完。注意如果make 不能找到或生成makefile，这并不是错误；makefile不总是必需的。

当使用-t或--touch选项时，不希望使用过时的makefile来决定那个目标来touch。所以-t选项对makefile更新不起作用；类似-q（or —question）和-n（or —just-print）不阻止makefile的更新，因为过时的makefile会产生错误的输出。这样make –f mfile –n foo会更新’mfile’，读入它，打印出更新’foo’需要执行的命令但不运行这些命令。与’foo’有关的命令是更新过的’mfile’中的内容。

但是有时不希望更新makefile，可以将makefile作为命令行的目标，当makefile被显式指定为目标时，-t选项也适用于它们。这样make –f mfile –n mfile foo会读入’mfile’，打印出更新执行的命令，’foo’的命令是当前的’mfile’中的内容。

重载makefile

可以使用include指令来包含其它makefile，增加目标的变量定义。然而，make不允许同一个目标有不同的命令，有其它的途径可以达到目的。 假设有`makefile’ 和’mfile’，’makfile’要包含’mfile’，但都有对于目标’foo’的规则。这是可以在’makefile’中写一条匹配任意模式的规则，指明当make在’makefile’中未找到目标时，搜索’mfile’:

foo: 
     frobnicate > foo 
%: force 
     @$(MAKE) -f mfile $@ 
force: ;

说明:

  • 当执行make foo时，make找到’makefile’，执行命令frobnicate > foo；
  • 执行make bar时，在’makefile’中未找到相应的规则，这时模式规则适用， 执行命令make –f mfile bar，’makefile’中未提及的其它目标也是类似的。

这种方法之所以工作是因为模式规则的模式是%，可以匹配任何的目标；这条规则的依赖是force，保证即使目标存在命令也会执行；force规则的命令为空防止’make’为其搜索隐式规则－这样会导致依赖循环。

makefile中的规则描述如何生成特定的文件，即规则的目标。规则列出了目标的依赖文件，指定生成或更新目标的命令。规则的次序是不重要的，除非是确定缺省目标：缺省目标是第一个makefile中的第一个规则；如果第一个规则有多个目标，第一个目标是缺省的。

有两个例外：

  • 以’.’开头的目标不是缺省目标；
  • 模式规则对缺省目标没有影响。

通常我们所写的地一个规则是编译整个或makefile中指定的所有程序。

规则的语法

语法如下：

TARGETS : DEPENDENCIES 
   COMMAND 
   ... 
   
或者 

TARGETS : DEPENDENCIES ; COMMAND 
   COMMAND 
   ...

TARGETS是以空格隔开的文件名，统配符可以使用。通常一个规则只有一个目标，偶尔也有多个。 命令行以TAB键开始。第一条命令可在依赖关系的下一行；或者在同一行，在分号后面；两种方式效果相同。 因为$符号被用做变量引用，如果要在规则中使用$符号，必须写两个：$$。可以用’’符号来分割一个长行，这不是必须的，因为make对行的长度没有限制。

通配符

规则中的文件名可以包含统配符，如*，?。 文件名前的字符~有特殊的含义。单独使用，或跟随一个/，代表用户的home目录，比如~/bin扩展为/home/you/bin；如果~跟随一个单词，表示单词指示的那个用户的home目录，如~john/bin扩展为/home/john/bin。

通配符在目标，依赖关系，命令中自动扩展，其它情况下，统配符的扩展除非显式使用wildcard函数。通配符的特殊意义可以使用’’符号关闭。

例子:

clean: 
	rm -f *.o 
 和 
print: *.c 
	lpr -p $? 
	touch print

通配符在定义变量时并不扩展，例如：

objects = *.o

则objects的值是字符串*.o；但是如果你将objects用于目标，依赖或命令中，扩展会进行。要将objects设置成扩展过的内容，使用：

objects := $(wildcard *.o)

通配符的缺陷

这是一个使用通配符的例子，但结果不是你所期望的。假设可执行文件’foo’是从当前目录中的所有’.o’文件生成的：

objects = *.o 
foo : $(objects) 
     cc -o foo $(CFLAGS) $(objects)

objects变量的值是字符串*.o。通配符扩展在规则’foo’中进行，于是所有存在的’.o’文件成为’foo’的依赖而且在需要时重新编译。但如果删除了所有的’.o’文件呢？

当通配符不匹配任何文件时，一切都保持原样：则’foo’依赖于一个叫做*.o的文件；由于这个文件不大可能存在，’make’程序会报告一个无法生成*.o文件的错误，这不是期待的结果。实际上可以用通配符获得期望结果，但是需要复杂的技术，包括wildcard函数和字符串替换函数。

wildcard函数

通配符自动在规则中进行。但是在变量赋值的和函数的参数中通配符不会扩展，如果在这些情况下需要通配符扩展，必须使用wildcard函数。语法如下：

$(wildcard PATTERN...)

这个在makefile任何地方出现的字符串，会被匹配任何一个文件名格式的以空格隔开的现有文件列表替换。如果没有任何文件匹配一个模式，这个模式从’wildcard’的输出中忽略，注意，这和上述的通配符的处理是不一样的。

‘wildcard’函数的一个功能是找出目录中所有的’.c’文件：

$(wildcard *.c)

可以通过替换后缀.c为.o从C文件列表得到目标文件的列表：

$(patsubst %.c,%.o,$(wildcard *.c))

这样，上节中的makefile改写为：

objects := $(patsubst %.c,%.o,$(wildcard *.c)) 
foo : $(objects) 
     cc -o foo $(objects)

这个makefile利用了编译C程序的隐含规则，所以不需要对编译写出显式的规则。（’:=’是’=’的一个变体）

注意：’PATTERN’是大小写敏感的。

include、-include、sinclude的区别

如果指示符“include”指定的文件不是以斜线开始（绝对路径，如/usr/src/Makefile…），而且当前目录下也不存在此文件；make将根据文件名试图在以下几个目录下查找：

  • 首先，查找使用命令行选项“-I”或者“–include-dir”指定的目录，如果找到指定的文件，则使用这个文件；
  • 否则继续依此搜索以下几个目录（如果其存在） ：/usr/gnu/include、/usr/local/include和/usr/include。

当在这些目录下都没有找到“include”指定的文件时，make将会提示一个包含文件未找到的告警提示，但是不会立刻退出。而是继续处理Makefile的后续内容。当完成读取整个Makefile后，make将试图使用规则来创建通过指示符“include”指定的但未找到的文件，当不能创建它时（没有创建这个文件的规则），make将提示致命错误并退出。会输出类似如下错误提示：

Makefile:错误的行数：未找到文件名：提示信息（No such file or directory） 
Make：*** No rule to make target ‘’. Stop

通常我们在Makefile中可使用“-include”来代替“include”，来忽略由于包含文件不存在或者无法创建时的错误提示（“-”的意思是告诉make，忽略此操作的错误。make继续执行）。像下边那样：

-include FILENAMES...

使用这种方式时，当所要包含的文件不存在时不会有错误提示、make也不会退出；除此之外，和第一种方式效果相同。以下是这两种方式的比较：

  • 使用include FILENAMES...，make程序处理时，如果“FILENAMES”列表中的任何一个文件不能正常读取而且不存在一个创建此文件的规则时make程序将会提示错误并退出。
  • 使用-include FILENAMES...的情况是，当所包含的文件不存在或者不存在一个规则去创建它，make程序会继续执行，只有真正由于不能正确完成终极目标的重建时（某些必需的目标无法在当前已读取的makefile文件内容中找到正确的重建规则），才会提示致命错误并退出。

为了和其它的make程序进行兼容。也可以使用“sinclude”来代替“-include”（GNU所支持的方式）。