tree wide: add IWYU pragma: export where needed
#20569
Merged
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
We occasionally have some public `foo.h` header that includes a private `foo_arch.h` header. Users are expected to include the `foo.h` header and not the `foo_arch.h`. However, clangd will claim that the `#include` of `foo.h` is unused if only functions / macros/ types / ... from `foor_arch.h` is used and nothing from `foo.h`. This adds the `IWYU pragma: export` comment to the include of `foo_arch.h` in `foo.h`, so that clangd treats functions / macros / types provided by `foo_arch.h` as if they were instead provided by `foo.h`, which fixes the false positives.
maribu
added
Type: enhancement
github-actions
bot
added
Area: core
chrysn
approved these changes
Apr 14, 2024
There was a problem hiding this comment.
I dislike the way this adds pragmas through comments, but that's on https://include-what-you-use.org/, and their tooling doesn't offer a more #pragma-tic way of annotation.
I trust your testing, and on the whole, this looks like a strict improvement. It'll need tooling to not bit-rot, but that shouldn't stop us from fixing the things that can be fixed now.
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.
Contribution description
We occasionally have some public
foo.hheader that includes a privatefoo_arch.hheader. Users are expected to include thefoo.hheader and not thefoo_arch.h. However, clangd will claim that the#includeoffoo.his unused if only functions / macros/ types / ... fromfoor_arch.his used and nothing fromfoo.h.This adds the
IWYU pragma: exportcomment to the include offoo_arch.hinfoo.h, so that clangd treats functions / macros / types provided byfoo_arch.has if they were instead provided byfoo.h, which fixes the false positives.Testing procedure
In
master, the include ofirq.his often incorrectly labeled as unneeded by clangd (e.g. in VS code). This should get rid of these false positives.Issues/PRs references
See also: #20570