Add IWYU pragmas to private headers which provide library symbols #1103
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
The Zephyr build system requires that modules have a `module.yml` file to specify where the module cmake and kconfig files are located. These can also be explicitly set as "external" meaning that they do not exist within the module tree, itself. These build file can still be specified elsewhere via cmake variables, explained more in-depth here: https://docs.zephyrproject.org/latest/develop/modules.html#modules-module-ext-root This change makes it such that ETL can be included more easily in zephyr projects running on embedded systems. A similar change can be observed in the public nanopb repository, where the repo only requires its own `zephyr/module.yml` file to be found by the zephyr build system, but the kconfig and cmake additions can exist outside of the library repository.
This will allow ETL to be included via west in a zephyr build without any additional wrappers or external kconfigs. Signed-off-by: Zach Van Camp <[email protected]> Co-authored-by: Zach Van Camp <[email protected]>
This prevents warnings in clang compiler and IWYU tool https://clangd.llvm.org/guides/include-cleaner#iwyu-pragmas https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md#iwyu-pragma-export
drewr95
approved these changes
May 20, 2025
|
This is nice when using clang-tidy as it always flags these headers and suggests to fix by including the direct private implementations. This also avoids having to set the .clang-tidy file to blanketly ignore these headers. |
jwellbelove
added a commit
that referenced
this pull request
May 21, 2025
) * Add Zephyr build system module.yml (#1074) The Zephyr build system requires that modules have a `module.yml` file to specify where the module cmake and kconfig files are located. These can also be explicitly set as "external" meaning that they do not exist within the module tree, itself. These build file can still be specified elsewhere via cmake variables, explained more in-depth here: https://docs.zephyrproject.org/latest/develop/modules.html#modules-module-ext-root This change makes it such that ETL can be included more easily in zephyr projects running on embedded systems. A similar change can be observed in the public nanopb repository, where the repo only requires its own `zephyr/module.yml` file to be found by the zephyr build system, but the kconfig and cmake additions can exist outside of the library repository. * Add full West support for ETL (#1075) This will allow ETL to be included via west in a zephyr build without any additional wrappers or external kconfigs. Signed-off-by: Zach Van Camp <[email protected]> Co-authored-by: Zach Van Camp <[email protected]> * Add IWYU pragmas to private headers which provide library symbols This prevents warnings in clang compiler and IWYU tool https://clangd.llvm.org/guides/include-cleaner#iwyu-pragmas https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md#iwyu-pragma-export --------- Signed-off-by: Zach Van Camp <[email protected]> Co-authored-by: Zach Van Camp <[email protected]> Co-authored-by: Zach Van Camp <[email protected]> Co-authored-by: John Wellbelove <[email protected]>
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.
This prevents warnings in clang compiler and IWYU tool
Example for
#include "etl/delegate.h"https://clangd.llvm.org/guides/include-cleaner#iwyu-pragmas
https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md#iwyu-pragma-export