By: 潘云登
Date: 2009-7-10
Email: intrepyd@gmail.com
Homepage: http://blog.csdn.net/intrepyd
Copyright: 该文章版权由潘云登所有。可在非商业目的下任意传播和复制。
对于商业目的下对本文的任何行为需经作者同意。
写在前面
这个备忘录是在阅读徐海兵的《中文make v3.80手册》时摘抄出来的Makefile例子和相关要点,为编写简单Makefile文件提供快速参考。如果要对Makefile进行系统学习,建议阅读原手册。另外,make自带的函数、命令行参数等说明,可在用到时从手册中查阅。
Makefile
备忘录
#sample Makefile edit : main.o kbd.o command.o display.o / insert.o search.o files.o utils.o cc -o edit main.o kbd.o command.o display.o / insert.o search.o files.o utils.o main.o : main.c defs.h cc -c main.c kbd.o : kbd.c defs.h command.h cc -c kbd.c command.o : command.c defs.h command.h cc -c command.c display.o : display.c defs.h buffer.h cc -c display.c insert.o : insert.c defs.h buffer.h cc -c insert.c search.o : search.c defs.h buffer.h cc -c search.c files.o : files.c defs.h buffer.h command.h cc -c files.c utils.o : utils.c defs.h cc -c utils.c clean : rm edit main.o kbd.o command.o display.o / insert.o search.o files.o utils.o |
l 一个规则可以有多个命令行,每一个命令行必须以[Tab]字符开始。
l 如果是多行命令,那么每一行命令将在一个独立的子shell进程中被执行。因此,在一个规则的命令中,命令行“cd”改变目录不会对其后的命令的执行产生影响。如果要实现这个目的,应该把两条命令写在一行上,用分号分隔。
l 可以将一个较长行使用反斜线(/)来分解为多行,但需要注意,反斜线之后不能有空格。
l Makefile中“#”字符后的内容被作为是注释内容。注释行的结尾如果存在反斜线(/),那么下一行也被作为注释行。当在Makefile中需要使用字符“#”时,可以使用反斜线加“#”(/#)来实现。
# sample Makefile objects = main.o kbd.o command.o display.o / insert.o search.o files.o utils.o
edit : $(objects) cc -o edit $(objects)
main.o : defs.h kbd.o : defs.h command.h command.o : defs.h command.h display.o : defs.h buffer.h insert.o : defs.h buffer.h search.o : defs.h buffer.h files.o : defs.h buffer.h command.h utils.o : defs.h
.PHONY : clean clean : -rm edit $(objects) |
l “objects”作为一个变量,代表所有的.o文件的列表,在需要使用该列表的地方使用“$(objects)”来表示它,而不需要罗列所有的.o文件列表。要使用符号“$”的地方,需要书写两个连续的(“$$”)。
l 变量名是大小写敏感的,推荐的做法是在对于内部定义定义的一般变量(例如:目标文件列表objects)使用小写方式,而对于一些参数列表(例如:编译选项CFLAGS)采用大写方式。
l 通过“=”定义的变量,是递归方式扩展的变量。在变量定义时,变量值中对其他变量的引用不会被替换展开;而是变量在引用它的地方替换展开的同时,它所引用的其它变量才会被一同替换展开。
l 使用“:=”定义的变量,是直接展开式变量。变量值中对其他量或者函数的引用在定义变量时被展开,因此不能实现对其后定义变量的引用。
l “?=”为条件赋值,只有此变量在之前没有赋值的情况下才会对这个变量进行赋值。
l 在Makefile中使用“+=”(追加方式)来实现对一个变量值的追加操作,使用空格和原有值分开。
l make本身能够自动完成对.c文件的编译并生成对应的.o文件,它执行命令“cc -c”来编译.c源文件。在书写Makefile时,可以省略掉描述.c文件和.o依赖关系的规则,而只需要给出.o目标所需要的.h文件。
l 通过“.PHONY”特殊目标将“clean”目标声明为伪目标,避免当磁盘上存在一个名为“clean”文件时,目标“clean”所在规则的命令无法执行。
l 在命令行之前使用“-”,意思是忽略命令“rm”的执行错误。
-include foo *.mk $(bar)
LIBS = libtest.a foo : foo.c | $(LIBS) $(CC) $(CFLAGS) $< -o $@ $(LIBS) |
l Makefile中包含其它文件所需要使用的关键字是“include”,它书写在独立的一行,不能以[Tab]字符开始。
l 规则依赖列表中管道符号“|”左边的是常规依赖,管道符号右边的就是“order-only”依赖。“order-only”依赖只有在目标文件不存在的情况下,才会参与规则的执行。当目标文件存在时此依赖不会参与规则的执行过程。
#sample Makefile objects := $(patsubst %.c,%.o,$(wildcard *.c))
foo : $(objects) cc -o foo $(objects) |
l “$(patsubst %.c,%.o,$(wildcard *.c))”,首先使用“wildcard”函数获取工作目录下的.c文件列表;之后将列表中所有文件名的后缀.c替换为.o。这样就得到在当前目录可生成的.o文件列表。
VPATH = src:../headers foo.o : foo.c defs.h hack.h -lcurses cc -c $(CFLAGS) $< -o $@ |
l 通过变量“VPATH”可以指定依赖文件的搜索路径,使用空格或者冒号(:)将多个需要搜索的目录分开,这样可以将源代码和二进制文件(.o文件和可执行文件)安排在不同的目录来进行区分管理。
l 自动化变量“$<”代表规则中通过目录搜索得到的依赖文件列表的第一个依赖文件。“$@”代表规则的目标。“$^”代表所有通过目录搜索得到的依赖文件的完整路径名(目录 + 一般文件名)列表。
l 当规则中依赖文件列表中存在一个“-lNAME”形式的文件时,make将根据“NAME”首先搜索当前系统可提供的共享库(.so),如果当前系统不能提供这个共享库,则搜索它的静态库(.a)。
SUBDIRS = foo bar baz .PHONY: subdirs $(SUBDIRS)
subdirs: $(SUBDIRS) $(SUBDIRS): $(MAKE) -C $@ foo: baz |
l 伪目标的一种使用场合是在make的并行和递归执行过程中。此情况下一般会存在一个变量,定义为所有需要make的子目录。
l 一个没有命令行的规则(如“foo: baz”),用来限制子目录的make顺序,如:限制同步目录“foo”和“baz”的make过程--在处理“foo”目录之前,需要等待“baz”目录处理完成。
#sample Makefile all : prog1 prog2 prog3 .PHONY : all
prog1 : prog1.o utils.o cc -o prog1 prog1.o utils.o prog2 : prog2.o cc -o prog2 prog2.o prog3 : prog3.o sort.o utils.o cc -o prog3 prog3.o sort.o utils.o |
l 在一个目录下如果需要创建多个可执行程序,我们可以将所有程序的重建规则在一个Makefile中描述。约定的做法是使用一个称为“all”的伪目标来作为终极目标,它的依赖文件就是那些需要创建的程序。
.PHONY: cleanall cleanobj cleandiff cleanall : cleanobj cleandiff -rm program cleanobj : -rm *.o cleandiff : -rm *.diff |
l 当一个伪目标作为另外一个伪目标依赖时,make将其作为另外一个伪目标的子例程来处理。
objects = foo.o bar.o all: $(objects)
#TARGETS ...: TARGET-PATTERN: PREREQ-PATTERNS ... # COMMANDS $(objects): %.o: %.c $(CC) -c $(CFLAGS) $< -o $@ |
l 静态模式规则,使用目标模式(TAGET-PATTERN)中“%”与目标文件匹配的部分(如:foo),替代对应的依赖模式中的模式字符“%”后,得到目标的依赖文件(如:foo.c)。
files = foo.elc bar.o lose.o $(filter %.o,$(files)): %.o: %.c $(CC) -c $(CFLAGS) $< -o $@
$(filter %.elc,$(files)): %.elc: %.el emacs -f batch-byte-compile $< |
l 如果目标文件列表存在多种格式,可以使用“filter”函数对这个文件列表进行分类。
....... ifeq ($(MAKELEVEL),0) all : msg else all : other endif …… …... msg: @echo ”Can not make in this directory!” …… …… |
l 如果规则的命令行以字符“@”开始,则make在执行这个命令时就不会回显这个将要被执行的命令(如:这里不显示echo)。
l 变量“MAKELEVEL”代表了调用的深度,通过它的值我们可以了解当前make递归调用的深度。最上一级时“MAKELEVEL”的值为“0”。
l make的命令行选项会被自动的通过环境变量“MAKEFLAGS”传递给子make进程。“-C”、“-f”、“-o”和“-W”除外。
#TARGET ... : VARIABLE-ASSIGNMENT foo : foo.c foo : CFLAGS+=-O2 bar : bar.c bar : CFLAGS+=-g
#PATTERN ... : VARIABLE-ASSIGNMENT %.o : CFLAGS += -O |
l 目标指定的变量值只在指定它的目标的上下文中有效,对于其他的目标没有影响。
l 模式指定变量定义是将一个变量值指定到所有符合此模式的目标上。
libs_for_gcc = -lgnu normal_libs =
ifeq ($(CC),gcc) libs=$(libs_for_gcc) else libs=$(normal_libs) endif
foo: $(objects) $(CC) -o foo $(objects) $(libs) |
l 关键字“ifeq”用来判断参数是否相等,关键字“ifneq”用来判断参数是否不相等,关键字“ifdef”用来判断一个变量是否已经定义,关键字“ifndef”实现的功能和“ifdef”相反。
l ifdef只是测试一个变量是否有值,不会对变量进行替换展开来判断变量的值是否为空。
cc -c $(CFLAGS) foo.c |
l 执行make时,一个含有“=”的命令行参数“V=X”的含义是定义变量“V”的值为“X”,这种方式定义的变量会替代Makefile中的同名变量定义,如:“make CFLAGS=’-g –O2’”。
l 如果不希望命令行指定的变量值替代在Makefile中的变量定义,那么我们需要在Makefile中使用指示符“override”来对这个变量进行声明。