summaryrefslogtreecommitdiffstats
path: root/Help/command/ctest_coverage.rst
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 15:17:36 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-15 18:12:03 (GMT)
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Help/command/ctest_coverage.rst
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadCMake-f051814ed0e63badbfd68049354f36259dbf4b49.zip
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
CMake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.bz2
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Help/command/ctest_coverage.rst')
-rw-r--r--Help/command/ctest_coverage.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/Help/command/ctest_coverage.rst b/Help/command/ctest_coverage.rst
new file mode 100644
index 0000000..4c90f9c
--- /dev/null
+++ b/Help/command/ctest_coverage.rst
@@ -0,0 +1,20 @@
+ctest_coverage
+--------------
+
+Collect coverage tool results.
+
+::
+
+ ctest_coverage([BUILD build_dir] [RETURN_VALUE res] [APPEND]
+ [LABELS label1 [label2 [...]]])
+
+Perform the coverage of the given build directory and stores results
+in Coverage.xml. The second argument is a variable that will hold
+value.
+
+The LABELS option filters the coverage report to include only source
+files labeled with at least one of the labels specified.
+
+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.