Skip to content

Commit e07087b

Browse files
committed
Added clarification for code coverage functions
An important distinction between the GCC/lcov and clang/LLVM patterns when excluding files.
1 parent ab8b422 commit e07087b

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Diff for: code-coverage.cmake

+2-2
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ endif()
210210
# ALL - Adds the target to the 'ccov-all' and 'ccov-all-report' targets, which merge several executable targets coverage data to a single report. Effective on executable targets.
211211
# EXTERNAL - For GCC's lcov, allows the profiling of 'external' files from the processing directory
212212
# COVERAGE_TARGET_NAME - For executables ONLY, changes the outgoing target name so instead of `ccov-${TARGET_NAME}` it becomes `ccov-${COVERAGE_TARGET_NAME}`.
213-
# EXCLUDE <REGEX_PATTERNS> - Excludes files of the patterns provided from coverage. **These do not copy to the 'all' targets.**
213+
# EXCLUDE <PATTERNS> - Excludes files of the patterns provided from coverage. Note that GCC/lcov excludes by glob pattern, and clang/LLVM excludes via regex! **These do not copy to the 'all' targets.**
214214
# OBJECTS <TARGETS> - For executables ONLY, if the provided targets are shared libraries, adds coverage information to the output
215215
# ARGS <ARGUMENTS> - For executables ONLY, appends the given arguments to the associated ccov-* executable call
216216
# ~~~
@@ -500,7 +500,7 @@ endfunction()
500500
# use with coverage dashboards (e.g. codecov.io, coveralls).
501501
# ~~~
502502
# Optional:
503-
# EXCLUDE <REGEX_PATTERNS> - Excludes files of the regex patterns provided from coverage.
503+
# EXCLUDE <PATTERNS> - Excludes files of the patterns provided from coverage. Note that GCC/lcov excludes by glob pattern, and clang/LLVM excludes via regex!
504504
# ~~~
505505
function(add_code_coverage_all_targets)
506506
# Argument parsing

0 commit comments

Comments
 (0)