Makefile

TOC

参考资料

默认 target

如果 makefile 里有设置 .DEFAULT_GOAL,比如 .DEFAULT_GOAL = build,则 make 等同于 make build

如果 makefile 里没有设置 .DEFAULT_GOALmake 会执行 makefile 里第一个 target。比如下面的例子,make 等同于 make all

# 默认目标
all: build

# 实际任务
build:
	@echo "Building..."

# 其他规则和依赖关系...

命令回显

默认情况下会把每个执行命令(包括注释)都回显到终端。可以在开头加一个 @ 来阻止回显。 比如 # echo 123 改成 @# echo 123

变量赋值

  • 惰性赋值 Lazy Assignment (=)
  • 立即赋值 Immediate Assignment (::= or ::=)
  • 立即并转义 Immediate with Escape (:::=)
  • 惰性缺省 Lazy Set if Absent (?=)
  • Appending (+=)
  • Shell Assignment (!=)

target 作用域的变量定义

target: a := 1
target: b := 2
target:
	@echo ${a}
  @echo ${b}

多个变量赋值不能写在一行。

Target-specific Variable Values

珍爱生命,远离 ifeq

避免在 ifeq 引用局部变量。ifeq 只做简单的判断,无法承担复杂的职责。

原因:这是因为 ifeq 不在 target 内部生效,它是文件级别的,因此不识别任何局部变量。

变通方法:使用 shell 语法,用 ; 把所有 shell 命令都写成一行。再用 \ 来换行。 但这会导致写起来非常难看,非常难调试。

ifeq 无法识别 Target-specific Variable Values

.PHONY: c
c: FILE := CHANGELOG
c:
ifeq ($(FILE),CHANGELOG)
	@echo 1
else
	@echo 2
endif

make c 会打印 2。

.PHONY: c
FILE := CHANGELOG
c:
ifeq ($(FILE),CHANGELOG)
	@echo 1
else
	@echo 2
endif

make c 会打印 1。

原因:这是因为 ifeq 不在 target 内部生效,它是文件级别的,因此不识别 Target-specific Variable Values。

解决方法:避免在 ifeq 引用局部变量。使用 shell 语法,用 ; 把所有 shell 命令都写成一行。再用 \ 来换行。但这会导致写起来非常难看,非常难调试。

ifeq 无法识别在 target 内部赋值的变量

原因和解决方法同上。

w := true
.PHONY: a
a:
	@echo "w=${w}"

ifeq ($w,true)
	@echo 1
else
	@echo 2
endif

make a 打印结果:

w=true
1
.PHONY: a
a:
	$(eval w := true)
	@echo "w=${w}"

ifeq ($w,true)
	@echo 1
else
	@echo 2
endif

make a 打印结果:

w=true
2

$PWD 为何出错?

在 Makefile 里写 docker run -v "$PWD:/site" 为何会出错? 因为 Makefile 里的变量必须用 ${var} 或者 $(var) 来写。 改成 docker run -v "${PWD}:/site" 即可。

make config

$shell 变量为何是空?

.PHONY: a
a:
	v=1
	echo "$$v"

make a 会打印 echo "$v"

.PHONY: a
a:
	v=1
	echo "$v"

make a 会打印 echo ""

这是因为 makefile 执行的 shell 命令,每行命令都是运行在独立的 shell 的。

解决方法:写成一行。

.PHONY: a
a:
	v=1; echo "$v"

在 target 内部使用条件判断

if 和 endif 不要有缩进。

target:
ifeq ($(VERSION),)
	@echo 1
else
  @echo 2
endif

在 target 内部赋值变量

使用 $(eval) 函数。$(eval a := 1)

参考 https://stackoverflow.com/questions/1909188/define-make-variable-at-rule-execution-time

但这种方法存在问题!,不要使用 $(eval) 在 target 内部赋值变量!你应该使用 shell 语法来操作变量。 原因见珍爱生命,远离 ifeq

注意 &&

.PHONY: a
a:
	@[[ -n '' ]] && echo 1

make a 会报错。因为 [[ -n '' ]] 的退出码是非 0 的,于是 [[ -n '' ]] && echo 1 整行的退出码也是非 0 的。即报错。

解决方案:

要么这么写

.PHONY: a
a:
	@[[ -n '' ]] && echo 1 || true

要么这么写

.PHONY: a
a:
	@if [[ -n '' ]]; then echo 1; fi

GNU make 与 BSD make 的区别

GNU make 会自动打印目录路径

b:
	@echo 1

a:
	@echo "$(shell $(MAKE) b)"

用 GNU make 执行 make a 就会打印 make[1]: Entering directory '...' 1 make[1]: Leaving directory '...'。 用 BSD make 执行 make a 就只有 1

由于 GNU make 会默认开启 –print-directory 选项。它在执行嵌套的 make 命令时,会自动打印 make: Entering directory '...'. make: Leaving directory '...'.,这可能会造成问题。

解决方法是加上 -s 参数。

b:
	@echo 1

a:
	@echo "$(shell $(MAKE) -s b)"