Add IWYU export pragmas. #1378
Open
Add IWYU export pragmas. #1378
Conversation
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
If a project is using the facade-header yaml-cpp/yaml.h it might get `misc-include-cleaner` warnings from the `clangd` language server and `clang-tidy` that this header is not providing directly the symbols used. The annotation with IWYU pragmas fixes that and tells the tools that it should consider all the includes as if they directly provided the symbol Documentation clangd and clang-tidy https://clang.llvm.org/extra/clang-tidy/checks/misc/include-cleaner.html points to https://clangd.llvm.org/design/include-cleaner#iwyu-pragmas This has been first implemented and docuemnted in the include-what-you-use project https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md#iwyu-pragma-begin_exportsend_exports Signed-off-by: Henner Zeller <[email protected]>
hzeller
added a commit
to hzeller/OpenROAD
that referenced
this pull request
Oct 24, 2025
This will trigger a new `misc-include-cleaner` warning as the yaml-header does not have IWYU annotations. So we should ignore such clang-tidy warning for now. I am upstreaming a fix in jbeder/yaml-cpp#1378 Signed-off-by: Henner Zeller <[email protected]>
hzeller
added a commit
to hzeller/OpenROAD
that referenced
this pull request
Oct 24, 2025
This will trigger a new `misc-include-cleaner` warning as the yaml-header does not have IWYU annotations. So we should ignore such clang-tidy warning for now. I am upstreaming the necessary IWYU pragmas in jbeder/yaml-cpp#1378 Signed-off-by: Henner Zeller <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
If a project is using the facade-header yaml-cpp/yaml.h it might get
misc-include-cleanerwarnings from theclangdlanguage server andclang-tidythat this header is not providing directly the symbols used.The annotation with IWYU pragmas fixes that and tells the tools that it should consider all the includes as if they directly provided the symbol
Documentation clangd and clang-tidy
https://clang.llvm.org/extra/clang-tidy/checks/misc/include-cleaner.html points to https://clangd.llvm.org/design/include-cleaner#iwyu-pragmas
This has been first implemented and docuemnted in the include-what-you-use project https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md#iwyu-pragma-begin_exportsend_exports