Makefile 101

  • $ make -f rules.txt (构建目标) or $ make --file=rules.txt (构建目标)

    • 上面代码指定make命令依据rules.txt文件中的规则,进行构建。
  • $ make (构建目标,e.g., source) 默认根据makefile or Makefile

    • make source: source 是一个伪目标,make source命令后,就会一次性生成 file1,file2,file3 三个文件。

      source: file1 file2 file3
      

二、Makefile文件的格式

`` < target > : < prerequisites> [tab] < commands >

``

  • target

    • 目标通常是(多个)文件名,之间用空格分隔文件名,指明Make命令所要构建的对象, e.g., a.txt
      • result.txt: source.txt
          cp source.txt result.txt
        
        result.txt 的前置条件是 source.txt 。
    • 某个操作的名字,这称为"伪目标"(phony target)。 目标是clean,它不是文件名,而是一个操作的名字,属于"伪目标" : $ make clean

        .PHONY: clean  # 声明clean是"伪目标"之后,make就不会去检查是否
        存在一个叫做clean的文件,而是每次运行都执行对应的命令。
        clean:
            rm *.o
      
  • commands

    • 每行命令之前必须有一个tab键。如果想用其他键,可以用内置变量.RECIPEPREFIX声明。
      .RECIPEPREFIX = >
      > echo Hello, world
      
      大于号(>)替代tab键
    • 每行命令在一个单独的shell中执行。这些Shell之间没有继承关系。

      var-lost:
        export foo=bar
        echo "foo=[\$\$foo]"
      
    • 用分号分隔 or 反斜杠转义 or .ONESHELL 可以让它们在同个shell 执行。

       var-kept:
           export foo=bar; echo "foo=[\$\$foo]"
       var-kept:
           export foo=bar; \
           echo "foo=[$$foo]"
      

Makefile文件的语法

  • # 这是注释
  • 正常情况下,make会打印每条命令,然后再执行. 在命令的前面加上@,就可以关闭回声。
      test:
          @# 这是测试
    
  • Make命令允许对文件名,进行类似正则运算的匹配,主要用到的匹配符是%。 比如,假定当前目录下有 f1.c 和 f2.c 两个源码文件

      %.o: %.c
      等同于下面的写法:
      f1.o: f1.c
      f2.o: f2.c
    
  • 变量和赋值符

    Makefile 允许使用等号自定义变量。

    txt = Hello World
    test:
      echo \$(txt)
      echo \$\$HOME
      v1 = \$(v2)
    

    上面代码中,变量 txt 等于 Hello World。调用时,变量需要放在 $( ) 之中。 调用Shell变量,需要在美元符号前,再加一个美元符号,这是因为Make命令会对美元符号转义。

  • 上面代码中,变量 v1 的值是另一个变量 v2。这时会产生一个问题,v1 的值到底在定义时扩展(静态扩展),还是在运行时扩展(动态扩展)?为了解决类似问题,Makefile一共提供了四个赋值运算符 (=、:=、?=、+=)

    VARIABLE = value
    \# 在执行时扩展,允许递归扩展。
    
    VARIABLE := value
    \# 在定义时扩展。
    
    VARIABLE ?= value
    \# 只有在该变量为空时才设置值。
    
    VARIABLE += value
    \# 将值追加到变量的尾端。
    
  • Make命令提供一系列内置变量,比如,$(CC) 指向当前使用的编译器,$(MAKE) 指向当前使用的Make工具。

  • 自动变量:

    • $@指代当前目标,就是Make命令当前构建的那个目标。比如,make foo的 $@ 就指代foo。
      a.txt b.txt: 
        touch $@
      等同于下面的写法。
      a.txt:
        touch a.txt
      b.txt:
        touch b.txt
      
    • $< 指代第一个前置条件。比如,规则为 t: p1 p2,那么$< 就指代p1。
      a.txt: b.txt c.txt
        cp $< $@ 
        等同于下面的写法。
      a.txt: b.txt c.txt
        cp b.txt a.txt
      
    • $? 指代比目标更新的所有前置条件,之间以空格分隔。比如,规则为 t: p1 p2,其中 p2 的时间戳比 t 新,$?就指代p2。
    • $^ 指代所有前置条件,之间以空格分隔。比如,规则为 t: p1 p2,那么 $^ 就指代 p1 p2 。
    • $ 指代匹配符 % 匹配的部分, 比如% 匹配 f1.txt 中的f1 ,$ 就表示 f1。
    • $(@D) 和 $(@F) 分别指向 $@ 的目录名和文件名。比如,$@是 src/input.c,那么$(@D) 的值为 src ,$(@F) 的值为 input.c。
dest/%.txt: src/%.txt
    @[ -d dest ] || mkdir dest
    cp $< $@
上面代码将 src 目录下的 txt 文件,拷贝到 dest 目录下。
首先判断 dest 目录是否存在,如果不存在就新建,
然后,$< 指代前置文件(src/%.txt), $@ 指代目标文件(dest/%.txt)

判断和循环 : Makefile使用 Bash 语法,完成判断和循环。

ifeq ($(CC),gcc)
  libs=$(libs_for_gcc)
else
  libs=$(normal_libs)
endif
上面代码判断当前编译器是否 gcc ,然后指定不同的库文件。
  • FOR LOOP

    • LIST = one two three
      all:
      for i in \$(LIST); do \
        echo \$\$i; \
      done
      

FUNCTION

Makefile 还可以使用函数,格式如下。

  • $(function arguments) 或者 ${function arguments}

  • shell 函数用来执行 shell 命令

      srcfiles := $(shell echo src/{00..99}.txt)
    
  • wildcard 函数用来在 Makefile 中,替换 Bash 的通配符。
      srcfiles := $(wildcard src/*.txt)
    
  • subst 函数 用来文本替换,格式如下。
    下面的例子将字符串"feet on the street"替换成"fEEt on the strEEt"。
      $(subst ee,EE,feet on the street)
    
  • patsubst函数 用于模式匹配的替换,格式如下。 $(patsubst pattern,replacement,text)
下面的例子将文件名"x.c.c bar.c",替换成"x.c.o bar.o"。
    $(patsubst %.c,%.o,x.c.c bar.c)
  • 替换后缀名函数的写法是:变量名 + 冒号 + 后缀名替换规则。它实际上patsubst函数的一种简写形式。
      min: $(OUTPUT:.js=.min.js)
    上面代码的意思是,将变量OUTPUT中的后缀名 .js 全部替换成 .min.js 。
    

Example

编译C语言项目

edit : main.o kbd.o command.o display.o 
    cc -o edit main.o kbd.o command.o display.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
    cc -c display.c

clean :
     rm edit main.o kbd.o command.o display.o

.PHONY: edit clean

results matching ""

    No results matching ""