Chore: Split public and internal headers #3880
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
... so that the paths are defined in a single location. This does not change the header file layout in the build folder, though.
This essentially hides the 'internal' headers from the code in the 'examples' build target. I.e. these files cannot use 'internal' headers, just like any consuming application.
... making sure that only the necessary headers are visible to any compilation unit.
|
LGTM. Maybe add a short one-liner explanation for the future you to |
securitykernel
approved these changes
Jan 10, 2024
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 is a follow-up for #3878 and causes a compilation error if we accidentally include an internal header in an example.
For that, I changed the layout of the header files linked into the build directory, like so:
The build system templates can then selectively decide for each compilation unit which include paths are required. Practically, we always need all three types, except for the 'examples' which do not see the 'internal' headers anymore.