ctest_coverage

Perform the :ref:CTest Coverage Step as a :ref:Dashboard Client.

.. code-block:: cmake

ctest_coverage([BUILD <build-dir>] [APPEND] [LABELS <label>...] [RETURN_VALUE <result-var>] [CAPTURE_CMAKE_ERROR <result-var>] [QUIET] )

Collect coverage tool results and stores them in Coverage.xml for submission with the :command:ctest_submit command.

The options are:

BUILD <build-dir> Specify the top-level build directory. If not given, the :variable:CTEST_BINARY_DIRECTORY variable is used.

APPEND Mark Coverage.xml for append to results previously submitted to a dashboard server since the last :command:ctest_start call. Append semantics are defined by the dashboard server in use. This does not cause results to be appended to a .xml file produced by a previous call to this command.

LABELS Filter the coverage report to include only source files labeled with at least one of the labels specified.

RETURN_VALUE <result-var> Store in the <result-var> variable 0 if coverage tools ran without error and non-zero otherwise.

CAPTURE_CMAKE_ERROR <result-var> .. versionadded:: 3.7

Store in the <result-var> variable -1 if there are any errors running the command and prevent ctest from returning non-zero if an error occurs.

QUIET .. versionadded:: 3.3

Suppress any CTest-specific non-error output that would have been printed to the console otherwise. The summary indicating how many lines of code were covered is unaffected by this option.