kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

CTestCoverageCollectGCOV: Improve documentation 

Clean up prose and mention support for CTEST_EXTRA_COVERAGE_GLOB.
This commit is contained in:
Zack Galbreath 2016-03-31 14:17:03 -04:00 committed by Brad King
parent 425d764685
commit 8ea1b0df58
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Modules/CTestCoverageCollectGCOV.cmake
View File

@ -2,14 +2,19 @@
# CTestCoverageCollectGCOV # CTestCoverageCollectGCOV
# ------------------------ # ------------------------
# #
# This module provides the function ``ctest_coverage_collect_gcov``. # This module provides the ``ctest_coverage_collect_gcov`` function.
# The function will run gcov on the .gcda files in a binary tree and then #
# package all of the .gcov files into a tar file with a data.json that # This function runs gcov on all .gcda files found in the binary tree
# contains the source and build directories for CDash to use in parsing # and packages the resulting .gcov files into a tar file.
# the coverage data. In addtion the Labels.json files for targets that # This tarball also contains the following:
# have coverage information are also put in the tar file for CDash to #
# asign the correct labels. This file can be sent to a CDash server for # * *data.json* defines the source and build directories for use by CDash.
# display with the # * *Labels.json* indicates any :prop_sf:`LABELS` that have been set on the
# source files.
# * The *uncovered* directory holds any uncovered files found by
# :variable:`CTEST_EXTRA_COVERAGE_GLOB`.
#
# After generating this tar file, it can be sent to CDash for display with the
# :command:`ctest_submit(CDASH_UPLOAD)` command. # :command:`ctest_submit(CDASH_UPLOAD)` command.
# #
# .. command:: cdash_coverage_collect_gcov # .. command:: cdash_coverage_collect_gcov