《跟我一起学Makefile》学习笔记

最近两天花时间读了一下陈皓老师的《跟我一起写Makefile》,这篇文章非常地详细地介绍了make的用法以及Makefile的常用写法,感谢耗子老师~本文是在学习陈皓的《跟我一起写Makefile》的过程中,对一些比较实用的内容做的笔记。

Makefile介绍:

  • Makefile的规则

    target...:prerequisites...
        command
    ...
    ...
    

    1.target可以是目标文件、可执行文件、伪目标

    2.prerequisites是生成target所需要的文件或目标

    3.command是需要执行的命令,其所在行必须以一个tab开始

    4.核心规则:如果prerequisites中有一个或以上的文件比target更新的话,那么command所定义的命令就会被执行

  • make会在makefile里寻找第一个目标文件,如果找到则将其作为最终的目标文件

  • makefile的变量是一个字符串,类似于C语言中的宏

  • make具有自动推导的功能,比如有一个目标是any.o,那么any.c就会是any.o的依赖文件(如果我们没有定义这个规则)。还有下面这个例子:

    objects = main.o first.o second.o \
          third.o end.o
    
    edit : $(objects)
        cc -o edit $(objects)
    
  • makefile中只有行注释,使用'#'字符

  • include关键字可以把别的makefile包含进来:
    include filename;
    如果文件没有指定绝对或相对路径,make会在当前目录下寻找,然后试图在指定的编译参数里寻找包含路径

书写规则:

  • 在makefile中,'-'号一般用来表示出错时不要退出,继续执行

  • make支持三个通配符:"*" "?" "~"

  • 如果想要让通配符在变量中展开,比如objects是所有.o文件名的集合,可以这样:

    objects:=$(wildcard \*.o)

  • Makefile中的特殊变量VPATH用来添加文件路径,多个路径间以:号分隔,例如:
    VPATH = src:../headers

全小写的vpath是make的关键字,它可以指定不同文件在不同的目录中。其用法如下:

  1. vpath pattern directories 为符合pattern模式的文件指定搜索目录directories
  2. vpath pattern 清除符合模式pattern的文件的搜索目录
  3. vpath 清除所有已经设置了的文件搜索目录

vpath中的pattern需要包含%,比如:
vpath %.h ../headers 要求make在"../headers"目录下搜索所有头文件(如果当前目录没有的话)

  • .PHONY是一个特殊标记,显式地指出一个目标是伪目标,这样make不会认为其是一个文件去寻找其生成规则了
  • 目标和伪目标都可以成为依赖,比如:
.PHONY: cleanall cleanobj cleandiff

cleanall : cleanobj cleandiff
    rm program

cleanobj :
    rm *.o
cleandiff :
    rm *.diff
  • $@这个变量表示着目前规则中所有目标的集合

  • 静态模式的语法:

    <target ...> : <target-pattern> : <prereq-patterns ...>

    ...

    targets定义一系列目标,可以有通配符,是目标的一个集合

    target-pattern是指明targets的模式,也就是目标集模式

    prereq-patterns是目标的依赖模式,它对target-pattern形成的模式再进行一次依赖目标的定义.

    例子:

    objects = foo.o bar.o
    
    all: $(objects)
    
    $(objects): %.o : %.c
    $(CC) -c $(CFLAGS) $&lt; -o $@
    

    其中$<表示所有依赖的目标集(foo.c bar.c), $@表示所有的目标集(foo.o bar.o)

书写命令:

  • make通常会将执行的命令输出到屏幕上,在命令前加@可以阻止这个输出
  • 如果有多条命令并且后面的命令需要用到前面的接锅,需要卸载同一行上,之间用;隔开
    例如:
    exec:
    cd /home/david
    pwd
    
    exec:
    cd /home/david; pwd
    

执行第一个exec, pwd打印当前目录,第二个是/home/david

  • 如果我们有一个子目录叫subdir,在总的makefile里可以这样写:
    subsys:
    cd subdir; $(MAKE)
    
    或者是:
    subsys:
    $(MAKE) -C subdir
    
  • 如果要给下层makefile传递参数,可以这样:
export var=value

或者:

var=value
export

如果要传递所有变量,只需要export就可以了。如果要取消变量,使用unexport。

  • SHELL和MAKEFLAGS这两个变量不管是否export,都要传递到下层的makefile中去
  • make的-w参数在嵌套执行中比较有用,作用是让我们看到当前的工作目录.使用-C参数时-w会自动打开
  • make可以将相同的命令序列定义为一个变量:
define run-yacc
yacc $(firstword $^)
mv y.tab.c $@
endef

使用变量

  • 如果要在Makefile中使用"$"字符,需要用"$$"表示
  • 定义变量可以直接用=,也可以用:=。两者的区别在于:=使用时,- - 只能用已经定义号的变量,而不是在使用时再赋值
    ?=操作符表示如果左边的变量未定义时将右值赋给它,否则什么也不做.例如:
nullstr:=
space:=$(nullstr) #end of the line

这里需要注意的是,nullstr是空变量,space这行中,最后的)和#之间有一个空格,所以space被定义成了空格。

  • 变量值的替换:
    ${var:a=b}表示将var中以a结尾的内容替换成b,比如:
foo := a.o b.o c.o
bar := $(foo:.o=.c)

那么${bar} = a.c b.c c.c,上面一句等同于:

bar := ${foo:%.o=%.c}

  • +=号左边的变量如果没有定义过,等同于=
  • 如果一个变量在前面有定义,那么同一文件里赋值给该变量的=号会继承前一次操作的赋值符,也就是=或:=

使用用条件判断

  • 条件表达式的语法:
    conditional-directive

text-if-true

endif

以及:

conditional-directive

text-if-true

else

text-if-false

endif

其中conditional-directive表示条件关键字,包括:

ifeq (arg1, arg2)
ifneq (arg1, arg2)
ifdef var
ifndef var

需要注意的是,ifdef只是测试一个变量是否有值,并不会扩展它。也就是说如果你定义了一个空的变量empvar,ifdef empvar 返回true

使用函数

  • 函数调用语法:

    $(function args)

    函数和参数之间有空格,多个参数之间用,隔开

  • 字符串操作函数

$(subst from,to,text)

将text中的from替换为to

$(patsubst pattern,replacement,text)

查找text中的单词是否符合模式pattern,如果匹配则以replacement替换.pattern可以包括通配符%表示任意长度的字符串.如果replace中也包含%,那么pattern中%代表的字符串和replace中一样,返回替换过的字符串

$(strip string)

去掉string中开头和结尾的空字符, 返回去掉空格的字符串

$(findstring find,in)

在in中查找find字符串,找到则返回find,否则返回空字符串

$(filter pattern...,text)

以pattern模式过滤text中的单词,返回符合模式的字符串

$(filter-out pattern..., text)

与filter相反

$(sort list)

给list中的单词按照升序排序,会去掉重复单词

$(word n,text)

取出text中的第n个单词

$(wordlist ss,e,text)

从text中取出从ss到e的单词串,b和e是数字

$(words text)

统计并返回text中的单词数

$(firstword text)

取出text中的第一个单词

文件名操作函数

$(dir names...)

从names中取出目录部分

$(notdir names...)

和dir相反

$(suffix name...)

从names中取出各个文件名的后缀

$(basename names...)

从names中取出哥哥文件的前缀

$(addsuffix suffix,names...)

把后缀suffix加到names中每个单词后面

$(addprefix prefix,names...)

把prefix加到names中每个单词前面

$(join list1,list2)

把list2中的单词加到list1的对应的单词后面

foreach 函数

$(foreach var,list,text)

把参数list中的单词逐一取出放到var指定的变量中,然后执行text所包含的表达式, 其中的var作用于仅存在于foreach中

if函数

$(if condition,then-part)$(if condition,then-part,else-part)

call函数

$(call expression;,param1;,param2;,param3;...)

origin函数

$(origin var)

origin函数告诉我们var是在哪里定义的,其返回值包括:undefined,default,environment,file,command line,override,automatic

  • shell函数

shell函数和"`"是相同的功能

  • 控制make的函数

error text

产生致命的错误信息

warning text

产生警告信息

隐含规则

自动化变量
$@: 表示规则中的目标文件集。在模式规则中,如果有多个目标,那么,“$@”就是匹配于目标中模式定义的集合。
$%: 仅当目标是函数库文件中,表示规则中的目标成员名。例如,如果一个目标是“foo.a(bar.o)”,那么“$%”是“bar.o”,“$@”就是“foo.a”。如果目标不是函数库文件(Unix 下是[.a],Windows 下是[.lib]),那么其值为空。

$<: 依赖目标中的第一个目标名字。如果依赖目标是以模式(即“%”)定义的,那么“$<;”将是符合模式的一系列的文件集。注意,其是一个一个取出来的。

$?: 所有比目标新的依赖目标的集合。以空格分隔。

$^: 所有的依赖目标的集合。以空格分隔。如果在依赖目标中有多个重复的,那个这个变量会去除重复的依赖目标,只保留一份。

$+: 这个变量很像“$^”,也是所有依赖目标的集合。只是它不去除重复的依赖目标。

$*: 这个变量表示目标模式中“%”及其之前的部分。如果目标是“dir/a.foo.b”,并且目标的模式是“a.%.b”,那么,“$”的值就是“dir/a.foo”。这个变量对于构造有关联的文件名是比较有较。如果目标中没有模式的定义,那么“$”也就不能被推导出,但是,如果目标文件的后缀是make 所识别的,那么“$”就是除了后缀的那一部分。例如:如果目标是“foo.c”,因为“.c”是make 所能识别的后缀名,所以,“$”的值就是“foo”。这个特性是GNU make 的,很有可能不兼容于其它版本的make,所以,你应该尽量避免使用“$”,除非是在隐含规则或是静态模式中。如果目标中的后缀是make所不能识别的,那么“$”就是空值。

推荐阅读更多精彩内容

  • 来自陈浩的一片老文,但绝对营养。 示例工程:3 个头文件*.h,和 8 个 C 文件*.c。 初 编译过程,源文件...
    周筱鲁阅读 2,391评论 0 16
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 66,851评论 12 114
  • makefile的规则 组成 target prerequisites commandtarget这一个或多个的目...
    Neucrack阅读 668评论 0 3
  • makefile关系到整个工程的编译规则,一个工程中的源文件不计其数,按其类型、功能、模块分别放在若干的目录当中,...
    Joe_HUST阅读 663评论 1 3
  • @(linux 编程)[开发技能, 工具使用] What is GNU Make Make 是控制工程中通过源码生...
    orientlu阅读 8,136评论 0 25