如何根据未设置/值的makefile变量中止make / makefile执行?
我想出了这个,但只有在调用者没有显式运行目标时才有效(即仅运行make
)。
ifeq ($(MY_FLAG),)
abort: ## This MUST be the first target :( ugly
@echo Variable MY_FLAG not set && false
endif
all:
@echo MY_FLAG=$(MY_FLAG)
我认为这样的事情是个好主意,但在make的手册中找不到任何内容:
ifndef MY_FLAG
.ABORT
endif
答案 0 :(得分:204)
TL; DR :使用error
function:
ifndef MY_FLAG
$(error MY_FLAG is not set)
endif
请注意,这些行不得缩进。更确切地说,这些行之前不得有任何标签。
如果您要测试许多变量,那么为此定义一个辅助函数是值得的:
# Check that given variables are set and all have non-empty values,
# die with an error otherwise.
#
# Params:
# 1. Variable name(s) to test.
# 2. (optional) Error message to print.
check_defined = \
$(strip $(foreach 1,$1, \
$(call __check_defined,$1,$(strip $(value 2)))))
__check_defined = \
$(if $(value $1),, \
$(error Undefined $1$(if $2, ($2))))
以下是如何使用它:
$(call check_defined, MY_FLAG)
$(call check_defined, OUT_DIR, build directory)
$(call check_defined, BIN_DIR, where to put binary artifacts)
$(call check_defined, \
LIB_INCLUDE_DIR \
LIB_SOURCE_DIR, \
library path)
的
这会输出如下错误:
Makefile:17: *** Undefined OUT_DIR (build directory). Stop.
真正的检查在这里完成:
$(if $(value $1),,$(error ...))
这反映了ifndef
条件的行为,因此定义为空值的变量也被视为“未定义”。但这仅适用于简单变量和显式空的递归变量:
# ifndef and check_defined consider these UNDEFINED:
explicitly_empty =
simple_empty := $(explicitly_empty)
# ifndef and check_defined consider it OK (defined):
recursive_empty = $(explicitly_empty)
正如@VictorSergienko在评论中所建议的那样,可能需要稍微不同的行为:
$(if $(value $1)
测试值是否为非空。如果变量是用空值定义的,有时 OK。我使用$(if $(filter undefined,$(origin $1)) ...
和
此外,如果它是一个目录并且必须存在,则在运行检查时,我会使用
$(if $(wildcard $1))
。但这将是另一个功能。
也可以扩展解决方案,以便只有在调用某个目标时才需要变量。
食谱内的$(call check_defined, ...)
将支票移入配方:
foo :
@:$(call check_defined, BAR, baz value)
的
前导@
符号关闭命令回显,:
是实际命令,shell no-op stub。
可以改进check_defined
函数以输出目标名称(通过$@
变量提供):
check_defined = \
$(strip $(foreach 1,$1, \
$(call __check_defined,$1,$(strip $(value 2)))))
__check_defined = \
$(if $(value $1),, \
$(error Undefined $1$(if $2, ($2))$(if $(value @), \
required by target `$@')))
因此,现在检查失败会产生格式良好的输出:
Makefile:7: *** Undefined BAR (baz value) required by target `foo'. Stop.
check-defined-MY_FLAG
特殊目标我个人会使用上面简单直接的解决方案。但是,例如,this answer建议使用特殊目标来执行实际检查。可以尝试概括并将目标定义为隐式模式规则:
# Check that a variable specified through the stem is defined and has
# a non-empty value, die with an error otherwise.
#
# %: The name of the variable to test.
#
check-defined-% : __check_defined_FORCE
@:$(call check_defined, $*, target-specific)
# Since pattern rules can't be listed as prerequisites of .PHONY,
# we use the old-school and hackish FORCE workaround.
# You could go without this, but otherwise a check can be missed
# in case a file named like `check-defined-...` exists in the root
# directory, e.g. left by an accidental `make -t` invocation.
.PHONY : __check_defined_FORCE
__check_defined_FORCE :
使用方法:
foo :|check-defined-BAR
的
请注意,check-defined-BAR
列为order-only(|...
)先决条件。
优点:
缺点:
make -t
(请参阅Instead of Executing Recipes)会污染您的根目录,其中包含大量check-defined-...
个文件。这是模式规则can't be declared .PHONY
。我相信,使用一些eval
魔法和secondary expansion黑客可以克服这些限制,虽然我不确定它是否值得。
答案 1 :(得分:27)
使用shell函数test
:
foo:
test $(something)
用法:
$ make foo
test
Makefile:2: recipe for target 'foo' failed
make: *** [foo] Error 1
$ make foo something=x
test x
答案 2 :(得分:6)
您可以使用IF进行测试:
check:
@[ "${var}" ] || ( echo ">> var is not set"; exit 1 )
结果:
$ make check
>> var is not set
Makefile:2: recipe for target 'check' failed
make: *** [check] Error 1
答案 3 :(得分:5)
对未设置的变量使用shell错误处理(请注意双$
):
$ cat Makefile
foo:
echo "something is set to $${something:?}"
$ make foo
echo "something is set to ${something:?}"
/bin/sh: something: parameter null or not set
make: *** [foo] Error 127
$ make foo something=x
echo "something is set to ${something:?}"
something is set to x
如果您需要自定义错误消息,请在?
:
$ cat Makefile
hello:
echo "hello $${name:?please tell me who you are via \$$name}"
$ make hello
echo "hello ${name:?please tell me who you are via \$name}"
/bin/sh: name: please tell me who you are via $name
make: *** [hello] Error 127
$ make hello name=jesus
echo "hello ${name:?please tell me who you are via \$name}"
hello jesus
答案 4 :(得分:3)
为简洁起见:
$ cat Makefile
check-%:
@: $(if $(value $*),,$(error $* is undefined))
bar:| check-foo
echo "foo is $$foo"
带有输出:
$ make bar
Makefile:2: *** foo is undefined. Stop.
$ make bar foo="something"
echo "foo is $$foo"
foo is something