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 的非错误输出。警告/错误摘要以及来自本机构建工具的输出不受此选项的影响。