build-system: Drop -Wno-error=documentation#21377
Merged
maribu merged 4 commits intoRIOT-OS:masterfrom Apr 10, 2025
Merged
Conversation
github-actions
bot
added
Area: build system
maribu
added
Area: doc
maribu
force-pushed
the
build-system/Werror=documentation
branch
from
13b352b to
20fe138
Compare
github-actions
bot
added
Area: pkg
github-actions
bot
added
Platform: native
maribu
force-pushed
the
build-system/Werror=documentation
branch
2 times, most recently
from
307bc54 to
20dbde1
Compare
maribu
force-pushed
the
build-system/Werror=documentation
branch
7 times, most recently
from
0a1b751 to
c786c78
Compare
maribu
added
CI: ready for build
maribu
force-pushed
the
build-system/Werror=documentation
branch
from
ccdeb43 to
a3e8d8e
Compare
maribu
force-pushed
the
build-system/Werror=documentation
branch
from
a3e8d8e to
24bfe66
Compare
benpicco
approved these changes
Apr 10, 2025
mguetschow
reviewed
Apr 10, 2025
maribu
removed
Area: network
This should fix compilation with -Wdocumentation on LLVM.
pkg/wamr has special handling for passing along includes, but assumed that all includes would be passed via `-I` and not `-isystem`. This now extends the special handling to support both.
We cannot fix package headers downstream, so we can just as well tell the compiler to not warn about them.
Treat documentation issues flagged by LLVM as hard errors. LLVM tends to be a lot less picky about documentation issues compared to Doxygen (e.g. no warning about missing doc), but warns about things that really are not intentional (e.g. `@param foo` when the argument has been renamed to `bar`, `@return` when the return type is `void`, ...). Having this as a base line requirement seems pretty sane.
maribu
force-pushed
the
build-system/Werror=documentation
branch
from
24bfe66 to
8e31630
Compare
github-actions
bot
added
Area: network
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.
Contribution description
Treat documentation issues flagged by LLVM as hard errors.
LLVM tends to be a lot less picky about documentation issues compared to Doxygen (e.g. no warning about missing doc), but warns about things that really are not intentional (e.g.
@param foowhen the argument has been renamed tobar,@returnwhen the return type isvoid, ...).Having this as a base line requirement seems pretty sane.
Testing procedure
Issues/PRs references
None