cmake: separate generated headers from translated headers#7263
Merged
Conversation
Make a distinction between generated headers and "translated" headers. This is important to support build-time dependencies when headers are updated. Generated headers are those which contain build-time feature specifications, like `git2_features.h` that are internal to the build and `experimental.h` that contain API information. Translated headers are the headers that are in `include/git2`, but may be translated to have a unique prefix like `incklude/git2-experimental`. This distinction is important so that the CMakeFiles.txt depend on the in-tree include files (`src/include`) and the generated header files _but not_ the translated header files. Otherwise there are two `pack.h` and it's unclear whether the in-tree build is targeting the one in `src/include` or the one in the build tree. Without this, updating an in-tree header file like `pack.h` would not cause a rebuild of its dependencies.
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
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.
Make a distinction between generated headers and "translated" headers. This is important to support build-time dependencies when headers are updated.
Generated headers are those which contain build-time feature specifications, like
git2_features.hthat are internal to the build andexperimental.hthat contain API information.Translated headers are the headers that are in
include/git2, but may be translated to have a unique prefix likeincklude/git2-experimental.This distinction is important so that the CMakeFiles.txt depend on the in-tree include files (
src/include) and the generated header files but not the translated header files. Otherwise there are twopack.hand it's unclear whether the in-tree build is targeting the one insrc/includeor the one in the build tree.Without this, updating an in-tree header file like
pack.hwould not cause a rebuild of its dependencies.