CMake packaging fixes #6966
Merged
CMake packaging fixes #6966
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
These are automatically set by CMake after processing HalideConfigVersion.cmake, so this code was totally pointless.
Before this change, users would either need to set Halide_ROOT to a Halide installation path or add said path to CMAKE_PREFIX_PATH. If they tried to use a different mechanism, like setting Halide_DIR or directly annotating their find_package call with HINTS or PATHS, then it would fail to find HalideHelpers.cmake. Adding this hint inside HalideConfig.cmake makes the package more robust, while still respecting the more powerful Halide_ROOT and CMAKE_PREFIX_PATH variables.
Some of our package's internal variables and macros leak out into user builds. We don't want users to use any of these. We might hit Hyrum's Law here, but I hope not. Users of these variables and macros should seek other means.
| unset(Halide_static_targets) | ||
|
|
||
| # Delete internal macros -- CMake saves redefined macros and functions with a | ||
| # single underscore prefixed so, for example, Halide_fail is still available as |
There was a problem hiding this comment.
I know! It's almost as crazy as foreach (i RANGE n) iterating over 0...n inclusive.
steven-johnson
approved these changes
Aug 23, 2022
ardier
pushed a commit
to ardier/Halide-mutation
that referenced
this pull request
Mar 3, 2024
* Add Halide_ASAN_ENABLED to package. * Fix handling of optional components. Make PNG/JPEG optional. * Make it easier to find HalideHelpers Before this change, users would either need to set Halide_ROOT to a Halide installation path or add said path to CMAKE_PREFIX_PATH. If they tried to use a different mechanism, like setting Halide_DIR or directly annotating their find_package call with HINTS or PATHS, then it would fail to find HalideHelpers.cmake. Adding this hint inside HalideConfig.cmake makes the package more robust, while still respecting the more powerful Halide_ROOT and CMAKE_PREFIX_PATH variables. * Delete undocumented variables in HalideConfig Some of our package's internal variables and macros leak out into user builds. We don't want users to use any of these. We might hit Hyrum's Law here, but I hope not. Users of these variables and macros should seek other means.
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 PR makes a few fixes to our CMake package (as used by
find_package).HalideHelpers, so that errors regarding not being able to find it are rarer (e.g. settingHalide_DIRinstead ofHalide_ROOT).Halide_ASAN_ENABLEDis added to the package to allow consumers to confirm that they found the right Halide when they are using ASAN in their own projects.REQUIRED-ness of the whole Halide package itself, not the individual component.find_package(Halide REQUIRED)will still succeed. If you need a specific dependency forHalide::ImageIO, you can make it required by writing, e.g.find_package(Halide REQUIRED PNG).HalideConfig.cmakeare now explicitly deleted withunsetand a re-definition trick. This keeps our package API in line with what's documented.