tools/doccheck: add simple exclude to doccheck#19240
Merged
bors[bot] merged 1 commit intoRIOT-OS:masterfrom Feb 7, 2023
Merged
tools/doccheck: add simple exclude to doccheck#19240bors[bot] merged 1 commit intoRIOT-OS:masterfrom
bors[bot] merged 1 commit intoRIOT-OS:masterfrom
Conversation
kfessel
added
the
CI: ready for build
maribu
reviewed
Feb 6, 2023
dist/tools/doccheck/exclude_simple
Outdated
Comment on lines
+1
to
+2
| drivers/ir_nec/include/ir_nec_params.h:35: warning: Member IR_NEC_PARAM_PIN (macro definition) of file ir_nec_params.h is not documented. | ||
| drivers/ir_nec/include/ir_nec_params.h:39: warning: Member IR_NEC_PARAMS (macro definition) of file ir_nec_params.h is not documented. |
Member
There was a problem hiding this comment.
These two actually need a regex to match the line numbers, otherwise anyone adding or deleting a line above the definition of the macros would need to touch this file again.
Contributor
Author
There was a problem hiding this comment.
right (they where like this in the exclude_patterns before)
! there are no regex in exclude_simple that is the reason it requires less memory !
Member
There was a problem hiding this comment.
Oops :(
Care to piggy-back a fix?
Contributor
Author
There was a problem hiding this comment.
i made that a exclude simple line
warning: Member IR_NEC_PARAM_PIN (macro definition) of file ir_nec_params.h is not documented.
warning: Member IR_NEC_PARAMS (macro definition) of file ir_nec_params.h is not documented.
see the fixup
kfessel
force-pushed
the
p-doccheck-simple
branch
from
bed6e5b to
6cb774e
Compare
uniq and sorted simple excludes removes no longer needed exclude patterns
kfessel
force-pushed
the
p-doccheck-simple
branch
from
6cb774e to
ce6a42e
Compare
maribu
approved these changes
Feb 7, 2023
Contributor
|
bors merge |
Contributor
|
Build succeeded: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
while doccheck runs for #19228 and #19220, i saw some spikes in memory consumption, turned out that was
grep -Evf dist/tools/doccheck/exclude_patternsusing about 2GB RAM. This PR changes that.Contribution description
add
exclude_simpletodoccheckdrived fromexclude patternssorted anduniqued the simple excludesremoves no longer needed patterns from
exclude patternssimple excludes are string rules (no patterns just strings)
how to apply these:
in this PR:
*remove the path and line number from the rule
another possible solution would be to have the excludes line number specific.
Testing procedure
run
dist/tools/doccheck/check.shcompare memory consumption of
master:
grep -Evf dist/tools/doccheck/exclude_patternsto
this PR:
grep -Fvf dist/tools/doccheck/exclude_simpleIssues/PRs references