Backport 2.28 : Remove -wDocumentation from Clang builds #7092
Conversation
This file contains 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
Clang 15/16 seems to have introduced new rules for -wDocumentation with respect to /return and /retval, which contradicts the rules we are using with Doxygen. I am therefore removing this warning as otherwise it will break builds for those using Clang 15/16, as the only other option is undertaking a mass re-write of our documentation. Signed-off-by: Paul Elliott <paul.elliott@arm.com>
paul-elliott-arm
added
bug
needs-review
3 tasks
tom-cosgrove-arm
added
single-reviewer
|
CI fully green |
tom-cosgrove-arm
added
the
approved
tom-cosgrove-arm
moved this from In Review
to Has Approval
in Roadmap Board for Mbed TLS
|
Closing as resolved by #7098 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
As per issue #6960, Clang 15/16 seems to have introduced new rules for -Wdocumentation with respect to /return and /retval, which contradicts the rules we are using with Doxygen.
This PR removes the usage of this warning from clang builds, as Clang 15 will soon be the default on rolling release builds, and those users will be broken.
This is a backport of #6966
Gatekeeper checklist
, or not requireddone, ornot requiredprovided, ornot requiredNotes for the submitter
Please refer to the contributing guidelines, especially the
checklist for PR contributors.