【Linux】makefile

Posted by 西维蜀黍 on 2020-04-25, Last Modified on 2021-09-21

Make的概念

Make这个词,英语的意思是"制作"。Make命令直接用了这个意思,就是要做出某个文件。比如,要做出文件a.txt,就可以执行下面的命令。

$ make a.txt

但是,如果你真的输入这条命令,它并不会起作用。因为Make命令本身并不知道,如何做出a.txt,需要有人告诉它,如何调用其他命令完成这个目标(这个人就是我们)。

比如,假设文件 a.txt 依赖于 b.txt 和 c.txt ,是后面两个文件连接(cat命令)的产物。那么,make 需要知道下面的规则。

# makefile 文件内容
a.txt: b.txt c.txt
    cat b.txt c.txt > a.txt

也就是说,make a.txt 这条命令的背后,实际上分成两步:第一步,确认 b.txt 和 c.txt 必须已经存在,第二步使用 cat 命令 将这个两个文件合并,输出为新文件。

像这样的规则,都写在一个叫做Makefile的文件中,Make命令依赖这个文件进行构建。Makefile文件也可以写为makefile, 或者用命令行参数指定为其他文件名:

$ make -f rules.txt
# 或者
$ make --file=rules.txt

上面代码指定make命令依据rules.txt文件中的规则,进行构建。

总之,make只是一个根据指定的Shell命令进行构建的工具。它的规则很简单,你规定要构建哪个文件、它依赖哪些源文件,当那些文件有变动时,如何重新构建它。

Makefile文件的格式

构建规则都写在Makefile文件里面,要学会如何Make命令,就必须学会如何编写Makefile文件。

概述

Makefile文件由一系列规则(rules)构成。每条规则的形式如下。

# makefile 文件内容
<target> : <prerequisites> 
[tab]  <commands>

上面第一行冒号前面的部分,叫做"目标"(target),冒号后面的部分叫做"前置条件"(prerequisites);第二行必须由一个tab键起首,后面跟着"命令"(commands)。

“目标"是必需的,不可省略;“前置条件"和"命令"都是可选的,但是两者之中必须至少存在一个。

每条规则就明确两件事:构建目标的前置条件是什么,以及如何构建。下面就详细讲解,每条规则的这三个组成部分。

目标(target)

一个目标(target)就构成一条规则。目标通常是文件名,指明Make命令所要构建的对象,比如上文的 a.txt 。目标可以是一个文件名,也可以是多个文件名,之间用空格分隔。

除了文件名,目标还可以是某个操作的名字,这称为"伪目标”(phony target)。

# makefile 文件内容
clean:
      rm *.o

上面代码的目标是clean,它不是文件名,而是一个操作的名字,属于"伪目标 “,作用是删除对象文件。

$ make  clean

但是,如果当前目录中,正好有一个文件叫做clean,那么这个命令不会执行。因为Make发现clean文件已经存在,就认为没有必要重新构建了,就不会执行指定的rm命令。

为了避免这种情况,可以明确声明clean是"伪目标”,写法如下。

# makefile 文件内容
.PHONY: clean
clean:
        rm *.o temp

声明clean是"伪目标"之后,make就不会去检查是否存在一个叫做clean的文件,而是每次运行都执行对应的命令。像.PHONY这样的内置目标名还有不少,可以查看手册

如果Make命令运行时没有指定目标,默认会执行Makefile文件中定义的第一个目标。

$ make

上面代码执行Makefile文件的第一个目标。

前置条件(prerequisites)

前置条件通常是一组文件名,之间用空格分隔。它指定了"目标"是否重新构建的判断标准:只要有任何一个前置条件(或者称为前置文件)不存在,或者有过更新(前置文件的last-modification时间戳比目标的时间戳新),“目标"就需要重新构建。

# makefile 文件内容
result.txt: source.txt
    cp source.txt result.txt

上面代码中,构建 result.txt 的前置条件是 source.txt 。因此,当前目录中,如果source.txt 已经存在了,make result.txt才可以正常运行,否则必须再写一条规则,来生成 source.txt 文件。


生成 source.txt 的规则:

# makefile 文件内容
source.txt:
    echo "this is the source" > source.txt

上面代码中,source.txt 规则后面没有前置条件,就意味着它跟其他文件都无关,只要这个文件还不存在,每次调用make source.txt,它都会生成。

$ make source.txt
echo "this is the source" > source.txt
$ make source.txt
make: `source.txt' is up to date.

在上面,我们连续执行两次make result.txt。第一次执行会生成 source.txt 文件,然后再新建 result.txt。第二次执行,Make发现 source.txt 没有变动(因为makefile文件的修改时间时间戳早于 source.txt文件的修改时间时间戳),就不会执行任何操作(而只是提示make: source.txt is up to date.)。


如果需要生成多个文件,往往采用下面的写法。

# makefile 文件内容
source: file1 file2 file3

上面代码中,source 是一个伪目标(因为只有三个前置文件,而没有任何对应的命令)。

$ make source
make: *** No rule to make target `file1', needed by `source'.  Stop.

执行make source命令后,就会报错了,这是因为 file1 是一个目标,但是没有被声明。

命令(commands)

命令(commands)表示如何更新目标文件,由一行或多行的Shell命令组成。它是构建"目标"的具体指令,它的运行结果通常就是生成目标文件。

每行命令之前必须有一个tab键。如果想用其他键,可以用内置变量 .RECIPEPREFIX 声明。

# makefile 文件内容
.RECIPEPREFIX = >
all:
> echo Hello, world

上面代码用.RECIPEPREFIX指定,大于号(>)替代tab键。所以,每一行命令的起首变成了大于号,而不是tab键。


需要注意的是,每行命令在一个单独的shell中执行。因此,这些命令是不相互共享context的。

例子:

# makefile 文件内容
var-lost:
    export foo=bar
    echo "foo=[$$foo]"

执行:

$ make var-lost
make: Nothing to be done for `var-lost'.

这是因为,在执行 echo "foo=[$$foo]" 时,取不到变量 foo 的值,所以提示执行 make var-lost 没有做任何事(make: Nothing to be done for var-lost'.)。

取不到foo的值,其实是因为两行命令在两个不同的shell进程执行。

一个解决办法是将两行命令写在一行,中间用分号分隔。

var-kept:
    export foo=bar; echo "foo=${foo}"

另一个解决办法是在换行符前加反斜杠转义。

var-kept:
    export foo=bar; \
    echo "foo=${foo}"

最后一个方法是加上.ONESHELL:命令。

.ONESHELL:
var-kept:
    export foo=bar; 
    echo "foo=${foo}"

一个go project的makefile Demo

COVER_PROFILE=cover.out
COVER_HTML=cover.html

.PHONY: $(COVER_PROFILE) $(COVER_HTML)

all: open

build: clean
	mkdir -p -v ./bin/amm.app/Contents/Resources
	mkdir -p -v ./bin/amm.app/Contents/MacOS
	cp ./appInfo/*.plist ./bin/amm.app/Contents/Info.plist
	cp ./appInfo/*.icns ./bin/amm.app/Contents/Resources/icon.icns
	go build -o ./bin/amm.app/Contents/MacOS/amm cmd/main.go

open: build
	open ./bin

clean:
	rm -rf ./bin

start:
	go run cmd/main.go

test:coverage

coverage: $(COVER_HTML)

$(COVER_HTML): $(COVER_PROFILE)
	go tool cover -html=$(COVER_PROFILE) -o $(COVER_HTML)

$(COVER_PROFILE):
	go test -v -failfast -race -coverprofile=$(COVER_PROFILE) ./...

vet:
	go vet $(shell glide nv)

lint:
	go list ./... | grep -v vendor | grep -v /assets/ |xargs -L1 golint -set_exit_status

.PHONY: build 
.PHONY: clean

Reference