Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Backport 2.28 : Remove -wDocumentation from Clang builds #7092

Closed
wants to merge 1 commit into from
Closed

Backport 2.28 : Remove -wDocumentation from Clang builds #7092

wants to merge 1 commit into from

Conversation

paul-elliott-arm
Copy link
Member

@paul-elliott-arm paul-elliott-arm commented Feb 13, 2023 •
edited
Loading

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

  • changelog provided , or not required
  • backport done, or not required
  • tests provided, or not required

Notes for the submitter

Please refer to the contributing guidelines, especially the
checklist for PR contributors.

@paul-elliott-arm
Remove -wDocumentation from Clang builds
c5d22d7 
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 paul-elliott-arm added bug needs-review Every commit must be reviewed by at least two team members, component-platform Portability layer and build scripts needs-ci Needs to pass CI tests needs-reviewer This PR needs someone to pick it up for review size-s Estimated task size: small (~2d) labels Feb 13, 2023
@paul-elliott-arm paul-elliott-arm self-assigned this Feb 13, 2023
@paul-elliott-arm paul-elliott-arm mentioned this pull request Feb 13, 2023
Closed
3 tasks
tom-cosgrove-arm
tom-cosgrove-arm approved these changes Feb 14, 2023
View reviewed changes
Copy link
Contributor

@tom-cosgrove-arm tom-cosgrove-arm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tom-cosgrove-arm tom-cosgrove-arm added single-reviewer This PR qualifies for having only one reviewer and removed needs-review Every commit must be reviewed by at least two team members, needs-ci Needs to pass CI tests needs-reviewer This PR needs someone to pick it up for review labels Feb 14, 2023
@tom-cosgrove-arm
Copy link
Contributor

CI fully green

@tom-cosgrove-arm tom-cosgrove-arm added the approved Design and code approved - may be waiting for CI or backports label Feb 14, 2023
@paul-elliott-arm
Copy link
Member Author

Closing as resolved by #7098

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tom-cosgrove-arm tom-cosgrove-arm tom-cosgrove-arm approved these changes

Assignees

@paul-elliott-arm paul-elliott-arm

Labels
approved Design and code approved - may be waiting for CI or backports bug component-platform Portability layer and build scripts single-reviewer This PR qualifies for having only one reviewer size-s Estimated task size: small (~2d)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@paul-elliott-arm @tom-cosgrove-arm