aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEli Schwartz <eschwartz@archlinux.org>2022-04-27 21:47:37 -0400
committerJussi Pakkanen <jpakkane@gmail.com>2022-05-06 22:55:37 +0300
commit1e4d4fce2250ab415964ad89c1d8b2c649b0b00d (patch)
tree00f0fe09348b64ddf0a4e106a45499f79b8be937 /docs
parenteef51fa3d60f2657d9687f99db3b5e989daef8c3 (diff)
downloadmeson-1e4d4fce2250ab415964ad89c1d8b2c649b0b00d.zip
meson-1e4d4fce2250ab415964ad89c1d8b2c649b0b00d.tar.gz
meson-1e4d4fce2250ab415964ad89c1d8b2c649b0b00d.tar.bz2
coverage: be clever and detect config files for gcovr/lcov
gcovr will read this file anyway, but if it exists we don't need to assume that the project wishes to exclude subprojects/ -- they can determine that themselves. Fixes #3287 Closes #9761 lcov doesn't read the config file by default, but we can do the smart thing here. Fixes #4628
Diffstat (limited to 'docs')
-rw-r--r--docs/markdown/snippets/coverage_config_files.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/markdown/snippets/coverage_config_files.md b/docs/markdown/snippets/coverage_config_files.md
new file mode 100644
index 0000000..2be1214
--- /dev/null
+++ b/docs/markdown/snippets/coverage_config_files.md
@@ -0,0 +1,12 @@
+## Coverage targets now respect tool config files
+
+gcovr >= 4.2 supports `gcovr.cfg` in the project source root to configure how
+coverage is generated. If Meson detects that gcovr will load this file, it no
+longer excludes the `subprojects/` directory from coverage. It's a good default
+for Meson to guess that projects want to ignore it, but not all projects prefer
+that and it is assumed that if a gcovr.cfg exists then it will manually
+include/exclude desired paths.
+
+lcov supports `.lcovrc`, but only as a systemwide or user setting. This is
+non-ideal for projects, so Meson will now detect one in the project source root
+and, if present, manually tell lcov to use it.