Skip to content

[Build] Disable -Wdocumentation #72747

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.

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

Merged
merged 1 commit into from
Apr 3, 2024

Conversation

bnbarham
Copy link
Contributor

@bnbarham bnbarham commented Apr 1, 2024

LLVM doesn't have this warning enabled, so we end up with a whole tonne of warnings from the LLVM headers.

LLVM doesn't have this warning enabled, so we end up with a whole tonne
of warnings from the LLVM headers.
@bnbarham
Copy link
Contributor Author

bnbarham commented Apr 1, 2024

@swift-ci please smoke test

Copy link
Member

@compnerd compnerd left a comment

Choose a reason for hiding this comment

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

I'm fine with removing it, but I do wonder why this was enabled in the first place.

@bnbarham bnbarham requested a review from akyrtzi April 1, 2024 21:54
@bnbarham
Copy link
Contributor Author

bnbarham commented Apr 1, 2024

I'm fine with removing it, but I do wonder why this was enabled in the first place.

@akyrtzi seems like you added this back in 2013 (bf25dde). How do you feel about it being removed? The only real alternative I can think of would be to have all our LLVM include paths as system, though I suspect that would have unintended side effects.

Otherwise there's the whack-a-mole game we could play with fixing upstream as these come in. Or a RFC to try get it enabled generally.

@tshortli
Copy link
Contributor

tshortli commented Apr 1, 2024

Thank you! These warnings have been polluting the Swift build quite a bit, and I don't think there's a point in having them if LLVM is not also going to be built with the flag to prevent the problems from occurring upstream.

@akyrtzi
Copy link
Contributor

akyrtzi commented Apr 1, 2024

@akyrtzi seems like you added this back in 2013 (bf25dde). How do you feel about it being removed?

I assume I added it because LLVM had it enabled then, if LLVM doesn't have it enabled then I agree to remove it.

Interestingly, I see upstream commits about fixing -Wdocumentation warnings, not sure how people discover them if it's not enabled.

@bnbarham
Copy link
Contributor Author

bnbarham commented Apr 1, 2024

Interestingly, I see upstream commits about fixing -Wdocumentation warnings, not sure how people discover them if it's not enabled.

Might have it locally like we do 😅? I definitely don't see a -Wdocumentation in LLVM, unless it's enabled by default with some other warning.

@tshortli
Copy link
Contributor

tshortli commented Apr 1, 2024

Might have it locally like we do 😅? I definitely don't see a -Wdocumentation in LLVM, unless it's enabled by default with some other warning.

They're all from Apple folks, so I suspect the problems are just being noticed downstream and fixed upstream to quite builds.

@bnbarham bnbarham merged commit e6a2021 into swiftlang:main Apr 3, 2024
@bnbarham bnbarham deleted the disable-doc-warning branch April 3, 2024 03:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants