diff options
author | Brad King <brad.king@kitware.com> | 2015-05-07 20:10:20 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2015-05-07 20:10:20 (GMT) |
commit | 695d6f62d31efc8c979e80713dc550a1b1054e00 (patch) | |
tree | cb86f349efe3f77432cfcc08cbb5dfdbae220be1 /Help/command/ctest_coverage.rst | |
parent | f8716c8b4466dd464853a5f9484ac151689c1d0c (diff) | |
download | CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.zip CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.tar.gz CMake-695d6f62d31efc8c979e80713dc550a1b1054e00.tar.bz2 |
Help: Revise ctest_* command documentation (#15559)
Revise documentation for the major dashboard client step ``ctest_*``
commands. Modernize the documentation formatting. Add some missing
options.
Diffstat (limited to 'Help/command/ctest_coverage.rst')
-rw-r--r-- | Help/command/ctest_coverage.rst | 44 |
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. |