New option --no-exclude-noncode-lines to not exclude noncode lines #704
Conversation
Only clang mark the closing brace as uncovered code.
Codecov ReportBase: 94.39% // Head: 95.48% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #704 +/- ##
==========================================
+ Coverage 94.39% 95.48% +1.09%
==========================================
Files 27 27
Lines 3498 3502 +4
Branches 605 606 +1
==========================================
+ Hits 3302 3344 +42
+ Misses 125 90 -35
+ Partials 71 68 -3
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
| GcovrConfigOption( | ||
| "exclude_noncode_lines", | ||
| ["--no-exclude-noncode-lines"], | ||
| group="gcov_options", | ||
| help="Exclude coverage from lines which seem to be non-code. Default: {default!s}.", | ||
| action="store_false", | ||
| ), |
There was a problem hiding this comment.
This comes a bit late, but note that options that are phrased as negations should be avoided.
- Negations can be more complicated to understand for users, especially here were we have a triple negation “no”, “exclude”, “noncode”.
- This interacts badly with config files.
For example, a config file entry no-exclude-noncode-lines = no is incomprehensible to me. The more I think about it, the less sure I am what is happening. As a user, I would also be confused by the help message:
--no-exclude-noncode-lines
Exclude coverage from lines which seem to be non-code.
Default: True.
Does this mean that the exclusion is enabled (true), or that the option (no-exclude) is enabled by default?
Here, this could be avoided by phrasing the option positively, and auto-generating a negation:
GcovrConfigOption(
"exclude_noncode_lines",
["--exclude-noncode-lines"],
group="gcov_options",
help="Exclude coverage from lines that don't seem to contain any code. Default: {default!s}.",
action="store_true",
const_negate=False, # <-- autogenerate --no-FLAG option
),Alternatively, if a --exclude-noncode-lines option should never be allowed, it would be sufficient here to explicitly name the config key via config="exclude-noncode-lines".
There was a problem hiding this comment.
I had also my problems with the name but the default is to remove lines which seems to have no code.
The easiest way would be to change our default to not remove them which can result in uncovered lines for the users. But then the user will get the line coverage which is also shown by gcov and this seems to be better.
There was a problem hiding this comment.
@latk I've tried your suggestion but it's only possible if the noncode lines are not excluded by default anymore. Our Command line parser doesn't allow a default for action="sore_true" (AssertionError: action=store_true and default conflict):
GcovrConfigOption(
"exclude_noncode_lines",
["--exclude-noncode-lines"],
config="exclude-noncode-lines",
group="gcov_options",
help="Exclude coverage from lines which seem to be non-code. Default: {default!s}.",
action="store_true",
const_negate=False,
default=True, # This has to be removed!
),I can go with this because than the default coverage numbers are closed to the numbers of gcov. Shall I do this breaking change?
Addresses and closes Issue #1211 ---------------------------------- The supposed problem was "Parallel processing of gcov data. ([#%s592](gcovr/gcovr#592))" in gcov 5.1. This was already fixed in 5.2. We need to add `--exclude-noncode-lines` due to a breaking change in gcovr 6.0, otherwise our coverage would change a lot (-0.33%): New [--exclude-noncode-lines](https://gcovr.com/en/stable/manpage.html#cmdoption-gcovr-exclude-noncode-lines) to exclude noncode lines. Noncode lines are not excluded by default anymore. ([#%s704](gcovr/gcovr#704), [#%s705](gcovr/gcovr#705)) Closes #1211 Update the gcovr-call ---------------------- - remove use of local bundled version (files were removed some years ago) - remove outdated exclude of folder `/Legacy/` - remind user to update gcovr to at least `v5.0` - assert if `v5.1` is used - black
This PR adds the flag
--no-exclude-noncode-linesto turn off the exclude of noncode lines (opening and closing braces which are tagged as uncovered by gcov).Only the test for clang has such lines, I haven't found a construct which works for GCC.
Related issue: #212