aboutsummaryrefslogtreecommitdiff
path: root/modules/ECMCoverageOption.cmake
blob: 16ecc2a55798769616c016a355167961a9abfac8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#.rst:
# ECMCoverageOption
# --------------------
#
# 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>`_.
#
# 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.

#=============================================================================
# SPDX-FileCopyrightText: 2014 Aleix Pol Gonzalez <aleixpol@kde.org>
#
# SPDX-License-Identifier: BSD-3-Clause

option(BUILD_COVERAGE "Build the project with gcov support" OFF)

if(BUILD_COVERAGE)
    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage")
    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -lgcov")
endif()