编写Makefile文件(转)

一 makefile规则
makefile是一个make的规则描述脚本文件，包括四种类型行：目标行、命令行、宏定义行和make伪指令行（如“include”）。makefile文件中注释以“#”开头。当一行写不下时，可以用续行符“\”转入下一行。
1.1 目标行
目标行告诉make建立什么。它由一个目标名表后面跟冒号“:”，再跟一个依赖性表组成。
例：
example: depfile deptarget
该目标行指出目标example与depfile和deptarget有依赖关系，如果depfile或deptarget有修改，则重新生成目标。
example1 example2 example3: deptarget1 deptarget2 depfile
该目标行指出目标名表中的example1、example2、example3这三个各自独立的目标是用相同的依赖列表和规则生成的。
clean:
空的依赖列表说明目标clean没有其他依赖关系。

目标行后续的以Tab 开始的行是指出目标的生成规则，该Tab字符不能以空格代替。例如：
example.o:example.c example.h
cc –c example.c
该例子指出目标example.o依赖于example.c和example.h。如果example.c或example.h其中之一改变了，就需要执行命令cc –c example.c重新生成目标example.o。
可以用文件名模式匹配来自动为目标生成依赖表，如：
prog: *.c

以下是一个简单的makefile的例子：

图 1 最简单的makefile例
make使用makefile文件时，从第一个目标开始扫描。上例中的第一个目标为all，所以目标clean不会自动被执行，可以通过命令make clean来生成目标。

1.2 命令行
命令行用来定义生成目标的动作。
在目标行中分号“;”后面的文件都认为是一个命令，或者一行以Tab制表符开始的也是命令。
如在上面的makefile例中，第三行以Tab字符开始的cc命令即是一个命令行，说明要生成hello应执行的命令。也可以写成：hello:hello.o;cc –c hello –L…
一般情况下，命令行的命令会在标准输出中回显出来，如对上面的makefile执行make时，标准输出如下：
cc -c hello.c
cc -o hello -L/usr/X11R6/lib -L/usr/lib -lXm -lXt -lX11 hello.o
cc -c hello1.c
cc -o hello1 -L/usr/X11R6/lib -L/usr/lib -lXm -lXt -lX11 hello1.o
如果不希望命令本身回显，可在命令前加@字符，如在上例中不希望回显cc –c hello.c和cc –c hello1.c，可修改makefile文件如下：



图 2 抑制回显的makefile例
对该makefile文件执行make时，标准输出如下：
cc -o hello -L/usr/X11R6/lib -L/usr/lib -lXm -lXt -lX11 hello.o
cc -o hello1 -L/usr/X11R6/lib -L/usr/lib -lXm -lXt -lX11 hello1.o
可以看出，命令行前有@字符的不回显。

1.3 宏定义行
在makefile中，可以使用宏定义减少用户的输入，例如上例中对hello和hello1的编译选项均为“-L/usr/X11R6/lib -L/usr/lib -lXm -lXt -lX11”，此时可以用宏来代替，如：
图 3 使用宏定义的makefile例
宏定义的基本语法是：
name=value
在定义宏时，次序不重要。宏不需要在使用前定义。如果一个宏定义多次，则使用最后一次的定义值。
可以使用“$”字符和“()”或“{}”来引用宏，例如：
cc –o hello.o $(CCFLAGS) hello.o
也可以将一个宏赋值给另一个宏，但这样的定义不能循环嵌套，如：
A=value1
B=value2
C=$(A) $(B)等价于C=value1 value2

1.4 伪指令
makefile大部分由宏定义行、命令行和目标行组成。第四种类型是make伪指令行。make伪指令没有标准化，不同的make可能支持不同的伪指令集，使得makefile有一定的不兼容性。如果要考虑移植性问题，则要避免使用make伪指令。但有一些伪指令，如include，由于使用比较多，很多不同make都提供该伪指令。
1.4.1 伪指令include
该伪指令类似C语言中的#include，它允许一次编写常用的定义并包括它。include伪指令必须在一行中，第一个元素必须是include，并且跟一个要包含的文件名，如：
include default.mk

1.4.2 伪指令“#”
“#”字符也是make的伪指令，它指出“#”后面的文件是注释，如：
PROGNAME=test # define macro
#don''t modify this

二 后缀规则
2.1 双后缀规则
在前面的makefile例中有许多重复内容，例如，生成hello和hello1的命令类似，生成hello.o和hello1.o的命令也类似，除了编译或链接的文件不一样外，其它均相同，这时，我们就可以使用后缀规则。首先看一个双后缀的例子：
图 4 使用双后缀规则的makefile例
后缀规则使用特殊的目标名“.SUFFIXES”。
第一行中.SUFFIXES的依赖表为空，用来清除原有的后缀规则，因为.SUFFIXES可以在makefile中多次使用，每一次都将新的后缀规则加入以前的后缀规则中。
第二行中指定后缀规则为“.c .o”，即表示将所有的.c文件转换为.o文件。
第三行指定将.c文件转换成.o文件的方法。$(CC)为make的预定义宏，其默认值为cc，$<为特殊的宏，代替当前的源文件，即所有要编译的.c文件。
第六行指定目标hello和hello1的生成方法。$@为特殊的宏，代替当前的目标名，即hello和hello1，$@.o即为hello.o和hello1.o。

上例介绍的是双后缀规则，即它包含两个后缀，如.c.o，用来把一个C源文件编译为目标文件。双后缀规则描述如何由第一个后缀类型的文件生成第二个后缀类型的文件，例如：.c.o规则描述如何由.c文件生成.o文件。

2.2 单后缀规则
单后缀规则描述了怎样由指定后缀的文件生成由它基名为名字的文件。例如使用单后缀规则.c，可以由hello.c和hello1.c生成hello和hello1文件。例如将前面的makefile改为：
图 5 使用单后缀规则的makefile例
由于.c后缀规则为make标准后缀规则，make为其指定了相应的命令行，所以在makefile中可以不用再指定其目标生成的具体命令行。

下表是make提供的标准后缀规则。
表 1 make标准后缀规则
后缀规则 命令行
.c $(LINK.c) –o $@ $< $(LDLIBS)
.c.ln $(LINK.c) $(POUTPUT OPTPUT OPTION) –i $<
.c.o $(COMPILE.c) $(OUTPUT OPTION) $<
.c.a $(COMPILE.c) –o $% $<
$(AR) $(ARFLAGS) $@ $%
$(RM) $%

三 特殊目标
在后缀规则中使用了特殊目标.SUFFIXES，用来指定新增的后缀规则。make还提供了几个特殊目标来设置make的行为，下面为一些特殊的目标：
? .IGNORE
make在执行命令行时，如果返回的是错误码，make的缺省动作是停止并退出。增加该目标后，make将忽略命令行返回的错误码，并继续执行后续的操作。

? .SILENT
前面已经介绍过，make在执行命令行时会回显命令行内容，在命令行前增加“@”字符将抑制该命令行的回显。
如果增加该目标，所有的命令行不再回显，相当于在每个命令行前均增加了“@”字符。

? .PRECIOUS
当收到一个信号或从shell命令返回非零的错误码时，make删除它所有已建立的文件。但有些文件即使出了错误，用户也不想让make删除，这些文件可以作为.PRECIOUS目标的参数。它可以在一个makefile中出现多次，每一次都累积文件列表。

? .SUFFIXES
它为makefile指定新的后缀规则，新的后缀规则作为.SUFFIXES的依赖表给出。.SUFFIXES可以在一个makefile中多次使用，每一次都将新的后缀规则加入以前的后缀规则中，如果.SUFFIXES的依赖表为空，则设置后缀规则表为空。

四 特殊的宏
为简单使用规则，make提供了几个特殊的宏：
? $@
整个当前目标名的值可以由宏“$@”来代替。

? $<
当前的源文件由“$<”来代替。例如，在前面的例子中用到了$(CC) –c $<，其中的“$<”是所有要编译的.c文件。宏“$<”仅在后缀规则或.DEFAULT中有效。

? $*
当前目标的基名由宏“$*”来代替。例如目标的名字是hello.o，则基名就是除去了后缀.o的hello。

以上介绍的特殊宏使用了make自身的规则，用户不可以改变。下表介绍了C中预定义的宏。
用途 宏 默认值
库文档汇编命令 AR ar
ARFLAGS rv
AS as
ASFLAGS
COMPILE.s $(AS) $(ASFLAGS) $(TARGET ARCH)
C编译器命令 CC cc
CFLAGS
CPPFLAGS
COMPILE.c $(CC) $(CFLAGS) $(CPPFLAGS) $(TARGET ARCH) –c
LINK.c $(CC) $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) $(TARGET ARCH)
链接编辑器命令 LD ld
LDFLAGS
rm命令 RM rm
后缀列表 SUFFIXES .o .c .c~ .s .s~ .S .S~ .ln .f .f~ .F .F~ .l .mod .mod~ .sym
.def .def~ .p .p~ .r .r~ .y .y~ .h .h~ .sh .sh~ .cps .cps~

五 makefile的应用
当调用make时，它在当前目录下搜索文件名是“makefile”或“Makefile”的文件，并执行。
如果不想使用上述缺省文件，可以使用命令行中的“-f”来指定文件，如将编写的makefile命名为mklib，则指定为“make –f mklib”。

 

 

 

 

 

1、make是通过比较对应文件（规则的目标和依赖）的最后修改时间，来决定哪些文件需要更新、那些文件不需要更新。对需要更新的文件， make就执行数据库中所记录的相应命令（在make读取Makefile后会建立一个编译过程的描述数据库。此数据库中记录了所有各个文件之间的相互关系，以及它们的关系描述）来重建它，对于不需要重建的文件make什么也不做。

2、在书写时，一个较长行可以使用反斜线（\）分解为多行，这样做可以使Makefile清晰、容易阅读。注意：反斜线之后不能有空格！

3、在实际工作中大家比较认同的方法是，使用一个变量“objects”、“OBJECTS”、“objs”、“OBJS”来作为所有的.o文件的列表的替代。在使用到这些文件列表的地方，使用此变量来代替。比如说定义了变量“OBJS”，那么就可以在需要的地方使用“$(OBJS)” 来表示它。

 

4、自动推导规则：make能够自动完成对.c文件的编译并生成对应的.o文件。这是make的隐含规则。

5、书写规则建议的方式是：单目标，多依赖。就是说尽量做到一个规则中只存在一个目标文件，可有多个依赖文件。尽量避免多目标，单依赖的方式。这样后期维护也会非常方便，而且Makefile会更加清晰明了。

6、在一个完整的Makefile中，包含了5个部分：显示规则、隐含规则、变量的定义、指示符和注释。

7、一个Makefile中可以包含其它的Makefile文件，利用关键字include实现，这和c语言对头文件的包含方式一致。 include指示符告诉make暂停读取当前的Makefile，而转去读取include指定的一个或多个文件，完成以后再继续当前Makefile 的读取。Makefile指示符include书写在独立的一行，其形式如下：

include FILENAMES

FILENAMES是shell所支持的文件名（可以使用通配符）。指示符include所在的行可以以一个或者多个空格（make在处理时将忽略这些空格）开始，但是切记不能以【TAB】字符开始。

8、make执行一个规则的过程：对于一个存在的规则（明确规则和隐含规则），首先，make程序将比较目标文件和所有的依赖文件的时间戳。如果目标的时间戳比所有依赖文件的时间戳更新，那么就什么也不做。否则，依赖文件中的某一个或者全部在上一次执行make后已经被修改过，规则所定义的重建目标的命令将会被执行。这是make工作的基础，也是其执行规则所定义命令的依据。

9、在规则中，通配符会被自动展开，但是在变量定义和使用函数时，通配符不会被自动展开。如果Makefile中有这么一句： “objects=*.o”，那么变量objects的值就是“*.o”，而不是使用空格分开的所有.o文件列表。如果需要变量“objects”代表所有的.o文件，则需要使用函数wildcard来实现bjects=$(wildcar *.o)。函数wildcard的用法是：$(wildcard PATTERN...)。在Makefile中，它被展开为已经存在的、空格分割的、匹配此模式的所有文件列表。如果不存在符合此模式的文件，那么函数会忽略模式并返回空。

10、Makefile中，如果在一个目录下如果需要创建多个可执行程序，我们可以将所有程序的重建规则在一个Makefile中描述。因为Makefile中第一个目标是“终极目标”，约定的做法是使用一个称为“all”的伪目标来作为终极目标，它的依赖文件就是那些需要创建的程序。

#sample Makefile
all: prog1 prog2 prog3
.PHONY: all

prog1: prog1.o utils.o
 $(CC) $(CFLAGS) $^ -o $@

prog2: prog2.o
 $(CC) $(CFLAGS) $^ -o $@

prog3: prog3.o sort.o utils.o
 $(CC) $(CFLAGS) $^ -o $@

当需要单独更新某一个程序时，我们可以通过make的命令行选项来明确指定需要重建的程序。

11、make存在一个内嵌隐含变量“RM”，它被定义为：“RM=rm -f”，因此在书写clean规则时的命令行可以使用$(RM)来代替rm，这样可以避免出现一个不必要的麻烦。这是推荐使用的做法。

12、如果要执行的命令以字符“@”开始，则make在执行时这个命令就不会被回显。典型的用法是我们在使用echo命令时输出一些信息时，如：
@echo "starting"
所以可以在书写Makefile时，使用@来控制命令的回显。

13、规则中，当目标需要被重建时，此规则定义的命令将会被执行，如果是多行命令，那么make就为每一行命令使用一个独立的子 shell去执行。因此，多行命令之间的执行是相互独立的，相互之间不存在依赖。而在Makefile中书写在同一行的多个命令属于一个完整的shell 命令行，所以需要注意：在一个规则的命令中，命令行cd改变目录并不会对其后的命令的执行产生影响。就是说其后的命令执行的工作目录不会是之前使用cd进入的那个目录。如果要实现这个目的，就不能把cd和其后的命令放在两行来书写。而应该把这两行命令写在一行上，用分号隔开。这样它们才是一个完整的 shell命令行。如果希望把一个完整的shell命令行书写在多行上，需要使用反斜杠来对处于多行的命令进行连接，表示它们是一个完整的shell命令行。

14、make的递归调用
在Makefile中使用“make”作为一个命令来执行本身或者其他makefile文件。递归调用在一个存在多级子目录的项目中非常有用。
subsystem:
 cd subdir && $(MAKE)
等价于
subsystem:
 $(MAKE) -C subdir
意思是进入子目录，然后在子目录下面执行make。

15、make可以定制命令包
在书写Makefile时，可能有多个规则会使用相同的一组命令，就像C语言程序中需要经常使用的函数printf。可以将一组命令进行类似c语言函数的封装，以后在需要的地方可以通过它的名字来对这一组命令中进行引用。这样就可以减少重复工作，提高了效率。在GNU make中，可以使用指示符define来完成这个功能，通常把define定义的一组命令成为一个命令包。定义一个命令包的语法以define开始，以 endef结束。

define run-yacc
yacc $(firstword $^)
mv y.tab.c $@
endef

这样，run-yacc就是这个命令包的名字。在define和endef之间的命令就是命令包的主体。需要说明的是，使用 define定义的命令包中，命令体中变量和函数的引用不会展开。命令体中所有的内容包括$等都是变量run-yacc的定义，它和C语言中宏的使用方式一样。
使用：
foo.c:foo.y
 $(run-yacc)

16、区分Makefile和shell中对变量应用的不同
Makefile单字符的引用可以为$x $(x) ${x}三种形式。多字符的引用$(xx) ${xx}.
而shell中变量的引用只有两种形式${xx} $xx.

一般在书写Makefile时，各部分变量引用的格式建议如下：
（1）make变量（Makefile中定义的变量或者是make的环境变量）的引用使用$(VAR)的格式，无论VAR是单字符变量名还是多字符变量名。
（2）出现在规则命令行中shell变量（一般为执行命令过程中的临时变量，它不属于Makefile变量，而是一个shell变量）引用使用shell的$tmp格式。
（3）对出现在命令行中的make变量同样使用$(CMDVAR)格式来引用。

17、尽量采用直接展开式变量，而不要用递归展开式变量。

18、作为一名优秀的程序员，在面对一个复杂问题时，应该是寻求一种尽可能简单、直接并且高效的处理方式来解决，而不是将一个简单问题在实现上复杂化。如果想在简单问题上突出自己使用某种语言的熟练程度，是一种非常愚蠢且不成熟的行为。

19、如果实现对一个之前没有定义过的变量进行赋值，可以使用?=。如果想对一个通用变量的值进行追加，使用+=。

 

 

 

 

 

转载于:https://www.cnblogs.com/guozhiming2003/archive/2010/01/12/1644665.html