diff --git a/Modules/CTestCoverageCollectGCOV.cmake b/Modules/CTestCoverageCollectGCOV.cmake index a4ca03a2ee..4c1211f5db 100644 --- a/Modules/CTestCoverageCollectGCOV.cmake +++ b/Modules/CTestCoverageCollectGCOV.cmake @@ -7,67 +7,82 @@ CTestCoverageCollectGCOV .. versionadded:: 3.2 -This module provides the ``ctest_coverage_collect_gcov()`` function. +This module is intended for use in CTest dashboard scripts and provides a +command to generate a tarball containing code coverage reports. -This function runs ``gcov`` on all ``.gcda`` files found in the binary tree -and packages the resulting ``.gcov`` files into a tar file. -This tarball also contains the following: +Load this module in a CTest script with: -* *data.json* defines the source and build directories for use by CDash. -* *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`. +.. code-block:: cmake -After generating this tar file, it can be sent to CDash for display with the -:command:`ctest_submit(CDASH_UPLOAD)` command. + include(CTestCoverageCollectGCOV) + +Commands +^^^^^^^^ + +This module provides the following command: .. command:: ctest_coverage_collect_gcov + Runs ``gcov`` and packages a tar file for CDash: + .. code-block:: cmake ctest_coverage_collect_gcov( - TARBALL - [TARBALL_COMPRESSION