ctest_build¶
以仪表盘客户端的身份执行CTest 构建步骤。
ctest_build([BUILD <build-dir>] [APPEND]
[CONFIGURATION <config>]
[PARALLEL_LEVEL <parallel>]
[FLAGS <flags>]
[PROJECT_NAME <project-name>]
[TARGET <target-name>]
[NUMBER_ERRORS <num-err-var>]
[NUMBER_WARNINGS <num-warn-var>]
[RETURN_VALUE <result-var>]
[CAPTURE_CMAKE_ERROR <result-var>]
)
构建项目并将结果存储在 Build.xml
中,以便使用 ctest_submit()
命令提交。
可以设置 CTEST_BUILD_COMMAND
变量以明确指定构建命令行。否则,构建命令行将根据给定的选项自动计算。
选项包括
BUILD <build-dir>
指定顶层构建目录。如果未给定,则使用
CTEST_BINARY_DIRECTORY
变量。APPEND
将
Build.xml
标记为追加到上次ctest_start()
调用以来已提交到仪表盘服务器的结果中。追加语义由所使用的仪表盘服务器定义。这并不会导致结果追加到此命令的上一次调用生成的.xml
文件中。CONFIGURATION <config>
指定构建配置(例如
Debug
)。如果未指定,将检查CTEST_BUILD_CONFIGURATION
变量。否则,将使用提供给ctest(1)
命令的-C <cfg>
选项(如果有)。PARALLEL_LEVEL <parallel>
3.21 版本新增。
指定底层构建系统的并行级别。如果未指定,将检查
CMAKE_BUILD_PARALLEL_LEVEL
环境变量。FLAGS <flags>
将附加参数传递给底层构建命令。如果未指定,将检查
CTEST_BUILD_FLAGS
变量。例如,这可以用于使用make
的-j
选项触发并行构建。请参阅ProcessorCount
模块以获取示例。PROJECT_NAME <project-name>
自 CMake 3.0 起已忽略。
3.14 版本中已更改: 此值不再是必需的。
TARGET <target-name>
指定要构建的目标名称。如果未指定,将检查
CTEST_BUILD_TARGET
变量。否则,将构建默认目标。这是“all”目标(在Visual Studio 生成器中称为ALL_BUILD
)。NUMBER_ERRORS <num-err-var>
将检测到的构建错误数量存储在给定变量中。
NUMBER_WARNINGS <num-warn-var>
将检测到的构建警告数量存储在给定变量中。
RETURN_VALUE <result-var>
将原生构建工具的返回值存储在给定变量中。
CAPTURE_CMAKE_ERROR <result-var>
3.7 版本中新增。
如果运行命令时有任何错误,则在
<result-var>
变量中存储 -1,并防止 ctest 在发生错误时返回非零值。QUIET
3.3 版本中新增。
抑制所有本应打印到控制台的非错误 CTest 特定输出。警告/错误的摘要以及原生构建工具的输出不受此选项影响。