Next: , Previous: , Up: The Macros  


ax_code_coverage

Synopsis

AX_CODE_COVERAGE()

Description

Defines CODE_COVERAGE_CPPFLAGS, CODE_COVERAGE_CFLAGS, CODE_COVERAGE_CXXFLAGS and CODE_COVERAGE_LIBS which should be included in the CPPFLAGS, CFLAGS CXXFLAGS and LIBS/LIBADD variables of every build target (program or library) which should be built with code coverage support. Also defines CODE_COVERAGE_RULES which should be substituted in your Makefile; and $enable_code_coverage which can be used in subsequent configure output. CODE_COVERAGE_ENABLED is defined and substituted, and corresponds to the value of the –enable-code-coverage option, which defaults to being disabled.

Test also for gcov program and create GCOV variable that could be substituted.

Note that all optimisation flags in CFLAGS must be disabled when code coverage is enabled.

Usage example:

configure.ac:

  AX_CODE_COVERAGE

Makefile.am:

  @CODE_COVERAGE_RULES@
  my_program_LIBS = ... $(CODE_COVERAGE_LIBS) ...
  my_program_CPPFLAGS = ... $(CODE_COVERAGE_CPPFLAGS) ...
  my_program_CFLAGS = ... $(CODE_COVERAGE_CFLAGS) ...
  my_program_CXXFLAGS = ... $(CODE_COVERAGE_CXXFLAGS) ...

This results in a "check-code-coverage" rule being added to any Makefile.am which includes "@CODE_COVERAGE_RULES@" (assuming the module has been configured with –enable-code-coverage). Running ‘make check-code-coverage‘ in that directory will run the module’s test suite (‘make check‘) and build a code coverage report detailing the code which was touched, then print the URI for the report.

In earlier versions of this macro, CODE_COVERAGE_LDFLAGS was defined instead of CODE_COVERAGE_LIBS. They are both still defined, but use of CODE_COVERAGE_LIBS is preferred for clarity; CODE_COVERAGE_LDFLAGS is deprecated. They have the same value.

This code was derived from Makefile.decl in GLib, originally licenced under LGPLv2.1+.

Source Code

Download the latest version of ax_code_coverage.m4 or browse the macro’s revision history.

License

Copyright © 2012, 2016 Philip Withnall
Copyright © 2012 Xan Lopez
Copyright © 2012 Christian Persch
Copyright © 2012 Paolo Borelli
Copyright © 2012 Dan Winship
Copyright © 2015 Bastien ROUCARIES

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.


Next: , Previous: , Up: The Macros