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 <建置目錄>

指定最上層的建置目錄。如果未指定，則會使用 CTEST_BINARY_DIRECTORY 變數。

APPEND

將 Build.xml 標記為附加到上次呼叫 ctest_start() 以來，先前提交到儀表板伺服器的結果。附加語意由使用的儀表板伺服器定義。這並不會導致結果附加到先前呼叫此命令產生的 .xml 檔案。

CONFIGURATION <設定>

指定建置設定 (例如 Debug)。如果未指定，則會檢查 CTEST_BUILD_CONFIGURATION 變數。否則，將使用傳遞給 ctest(1) 命令的 -C <cfg> 選項 (如果有的話)。

PARALLEL_LEVEL <平行層級>

在 3.21 版本中新增。

指定底層建置系統的平行層級。如果未指定，則會檢查 CMAKE_BUILD_PARALLEL_LEVEL 環境變數。

FLAGS <旗標>

將其他引數傳遞給底層的建置命令。如果未指定，則會檢查 CTEST_BUILD_FLAGS 變數。例如，這可以用於使用 make 的 -j 選項觸發平行建置。請參閱 ProcessorCount 模組以取得範例。

PROJECT_NAME <專案名稱>

自 CMake 3.0 起已忽略。

在 3.14 版本中變更：此值不再是必要的。

TARGET <目標名稱>

指定要建置的目標名稱。如果未指定，則會檢查 CTEST_BUILD_TARGET 變數。否則，將建置預設目標。這是 "all" 目標 (在 Visual Studio Generators 中稱為 ALL_BUILD)。

NUMBER_ERRORS <錯誤數變數>

將偵測到的建置錯誤數量儲存在給定的變數中。

NUMBER_WARNINGS <警告數變數>

將偵測到的建置警告數量儲存在給定的變數中。

RETURN_VALUE <結果變數>

將原生建置工具的傳回值儲存在給定的變數中。

CAPTURE_CMAKE_ERROR <結果變數>

在 3.7 版本中新增。

如果執行命令時有任何錯誤，則在 <結果變數> 變數中儲存 -1，並防止 ctest 在發生錯誤時傳回非零值。

QUIET

在 3.3 版本中新增。

抑制任何本來會列印到主控台的 CTest 特定的非錯誤輸出。警告/錯誤的摘要，以及原生建置工具的輸出不受此選項的影響。