coverage: Specify modules to run coverage for #11592
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stephenfin
force-pushed
the
coverage-all-modules
branch
2 times, most recently
from
573b65f to
02942b0
Compare
stephenfin
force-pushed
the
coverage-all-modules
branch
3 times, most recently
from
bb5c3c3 to
334c21c
Compare
Contributor
Author
|
I'll wait for the test to re-run, but it looks like the CI failures are flakes and this is otherwise passing as expected. @AA-Turner Who's the best person other than me to review this and try get it into 7.3/8.0? |
Contributor
Author
|
fwiw, I came up with this after spotting the gap while trying to use coverage for a project I contribute to. After testing, it seemed to do what I expected and highlighted a whole load of missing documentation. |
stephenfin
force-pushed
the
coverage-all-modules
branch
from
334c21c to
3d87303
Compare
Contributor
Author
Yes, we do. Added now |
stephenfin
force-pushed
the
coverage-all-modules
branch
2 times, most recently
from
9b75042 to
31829a9
Compare
picnixz
reviewed
Sep 6, 2023
picnixz
reviewed
Sep 9, 2023
Member
picnixz
left a comment
picnixz
left a comment
There was a problem hiding this comment.
Just so that you know, I didn't review the doc content.
Contributor
Author
Thanks. I think I have addressed everything now? |
Member
|
I think so. At least I don't have anything more in mind, except the todo for the doc but as you mentioned, it'll be another PR |
stephenfin
force-pushed
the
coverage-all-modules
branch
from
ca6ad22 to
34c02ff
Compare
Contributor
Author
|
@AA-Turner this is done now |
stephenfin
force-pushed
the
coverage-all-modules
branch
from
34c02ff to
d474029
Compare
AA-Turner
reviewed
Oct 6, 2023
AA-Turner
reviewed
Oct 6, 2023
Currently, the coverage builder lets you check for partially documented modules, but there is no mechanism to identify totally undocumented modules. Resolve this by introducing a new 'coverage_modules' config option. This is a list of modules that should be documented somewhere within the documentation tree. Any modules that are specified in the configuration value but are not documented anywhere will result in a warning. Likewise, any modules that are not in the config option but are documented somewhere will result in a warning. Signed-off-by: Stephen Finucane <[email protected]>
This prevent the table changing every time we generate the report. Signed-off-by: Stephen Finucane <[email protected]>
We migrate the code we're measuring coverage for to a package so we can validate the new module coverage functionality. Signed-off-by: Stephen Finucane <[email protected]>
Signed-off-by: Stephen Finucane <[email protected]>
Co-authored-by: Adam Turner <[email protected]>
stephenfin
force-pushed
the
coverage-all-modules
branch
from
3a799d2 to
c16453e
Compare
Member
|
Thanks! A |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature or Bugfix
Feature
Purpose
Currently, the coverage builder lets you check for partially documented modules, but there is no mechanism to identify totally undocumented modules. Resolve this by introducing a new
coverage_modulesconfig option. This is a list of modules that should be documented somewhere within the documentation tree. Any modules that are specified in the configuration value but are not documented anywhere will result in a warning. Likewise, any modules that are not in the config option but are documented somewhere will result in a warning.Detail
(none)
Relates
(none)