aboutsummaryrefslogtreecommitdiff
path: root/modules/ECMCoverageOption.cmake
diff options
context:
space:
mode:
authorl10n daemon script <scripty@kde.org>2015-11-08 21:01:33 +0000
committerl10n daemon script <scripty@kde.org>2015-11-08 21:01:33 +0000
commit7feccae76e01a65b406995b5ba9526fe9ade4299 (patch)
tree99011137f4dedcf4bf242e167ac7dc70d9136b8e /modules/ECMCoverageOption.cmake
parenta1bb0b0488843165e606771b75a3a67ba8a131a6 (diff)
parentc88bc78e0ca3834c46b89ca9d14b404751da5d4a (diff)
downloadextra-cmake-modules-5.16.0-rc2.tar.gz
extra-cmake-modules-5.16.0-rc2.tar.bz2
Merge remote-tracking branch 'origin/master' into local_releasev5.16.0-rc2v5.16.0
Diffstat (limited to 'modules/ECMCoverageOption.cmake')
-rw-r--r--modules/ECMCoverageOption.cmake19
1 files changed, 10 insertions, 9 deletions
diff --git a/modules/ECMCoverageOption.cmake b/modules/ECMCoverageOption.cmake
index 8d435de8..4c1db9de 100644
--- a/modules/ECMCoverageOption.cmake
+++ b/modules/ECMCoverageOption.cmake
@@ -2,19 +2,20 @@
# ECMCoverageOption
# --------------------
#
-# Creates a BUILD_COVERAGE option, so the project can be built with code coverage
-# support.
+# Allow users to easily enable GCov code coverage support.
#
-# ::
+# Code coverage allows you to check how much of your codebase is covered by
+# your tests. This module makes it easy to build with support for
+# `GCov <https://gcc.gnu.org/onlinedocs/gcc/Gcov.html>`_.
#
-# BUILD_COVERAGE
-#
-# If it's on, the project will be compiled with code coverage support, using
-# gcov. Otherwise, it will be built normally.
-#
-# ::
+# When this module is included, a ``BUILD_COVERAGE`` option is added (default
+# OFF). Turning this option on enables GCC's coverage instrumentation, and
+# links against ``libgcov``.
#
+# Note that this will probably break the build if you are not using GCC.
#
+# Since 1.3.0.
+
#=============================================================================
# Copyright 2014 Aleix Pol Gonzalez <aleixpol@kde.org>
#