diff options
Diffstat (limited to 'modules/ECMCoverageOption.cmake')
| -rw-r--r-- | modules/ECMCoverageOption.cmake | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/modules/ECMCoverageOption.cmake b/modules/ECMCoverageOption.cmake index 4cfe6641..4c1db9de 100644 --- a/modules/ECMCoverageOption.cmake +++ b/modules/ECMCoverageOption.cmake @@ -2,15 +2,17 @@ # 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 +# 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``. # -# If it's on, the project will be compiled with code coverage support, using -# gcov. Otherwise, it will be built normally. +# Note that this will probably break the build if you are not using GCC. # # Since 1.3.0. |