summaryrefslogtreecommitdiffstats
path: root/Help/command/ctest_coverage.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Help/command/ctest_coverage.rst')
-rw-r--r--Help/command/ctest_coverage.rst44
1 files changed, 29 insertions, 15 deletions
diff --git a/Help/command/ctest_coverage.rst b/Help/command/ctest_coverage.rst
index bac5c1c..12429b9 100644
--- a/Help/command/ctest_coverage.rst
+++ b/Help/command/ctest_coverage.rst
@@ -1,25 +1,39 @@
ctest_coverage
--------------
-Collect coverage tool results.
+Perform the :ref:`CTest Coverage Step` as a :ref:`Dashboard Client`.
::
- ctest_coverage([BUILD build_dir] [RETURN_VALUE res] [APPEND]
- [LABELS label1 [label2 [...]]])
+ ctest_coverage([BUILD <build-dir>] [APPEND]
+ [LABELS <label>...]
+ [RETURN_VALUE <result-var>]
+ [QUIET]
+ )
-Perform the coverage of the given build directory and stores results
-in Coverage.xml. The second argument is a variable that will hold
-value.
+Collect coverage tool results and stores them in ``Coverage.xml``
+for submission with the :command:`ctest_submit` command.
-The LABELS option filters the coverage report to include only source
-files labeled with at least one of the labels specified.
+The options are:
-The APPEND option marks results for append to those previously
-submitted to a dashboard server since the last ctest_start. Append
-semantics are defined by the dashboard server in use.
+``BUILD <build-dir>``
+ Specify the top-level build directory. If not given, the
+ :variable:`CTEST_BINARY_DIRECTORY` variable is used.
-The QUIET option suppresses 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.
+``APPEND``
+ Mark results for append to those previously submitted to a
+ dashboard server since the last :command:`ctest_start` call.
+ Append semantics are defined by the dashboard server in use.
+
+``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.
+
+``QUIET``
+ 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.