Normalize header install path (backport #467) #474
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
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?s=60&v=4){kind=small}
The "meta" header containing a list of all includes in the package is currently installed one folder above the other includes. This cleans up the definition of that install path by normalizing it to fix a cmake warning and also renaming some variables for clarity. Signed-off-by: Steve Peters <[email protected]> (cherry picked from commit 5b556fb)
8 tasks
scpeters
reviewed
Feb 13, 2025
cmake/GzInstallAllHeaders.cmake
Outdated
| # Generate the "master" header that includes all of the headers | ||
| configure_file(${master_header_in} ${master_header_out}) | ||
| # Generate the install directory for the "meta" header one folder above the "config" header | ||
| cmake_path(SET meta_header_install_dir NORMALIZE ${config_header_install_dir}/..) |
There was a problem hiding this comment.
this command was added in cmake 3.20, so wrap this in a ${CMAKE_VERSION} check
Signed-off-by: Steve Peters <[email protected]>
|
before merging:
|
this test has only the same 5 compilation warnings as the previous run: |
scpeters
approved these changes
Feb 14, 2025
|
I'll merge this and make a prerelease for further testing |
|
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.
🦟 Bug fix
Fixes #461
Summary
The "meta" header file that contains includes of all other core / component header files is installed to a relative path, one folder above the other include files. This was causing a cmake warning that the path wasn't normalized. This PR normalizes that path variable to fix the warning. It also renames some variables from
master_*tometa_*(6bd2d3d) for consistency and improved language and defines distinct variables for theconfig_header_install_dirandmeta_header_install_dir(part of d32068d) to clarify what each variable represents, since the "meta" header previously wasn't actually installed tometa_header_install_dir.This should be tested with downstream packages, including
gz-plugin(to confirm the cmake warning is fixed) andsdformat(which uses theREPLACE_INCLUDE_PATHoption).Checklist
codecheckpassed (See contributing)Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining
Signed-off-bymessages.This is an automatic backport of pull request #467 done by [Mergify](https://mergify.com).