Fix CMake module base filename #13
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
This patch renames `example.cmake` to `example-config.cmake`. This fixes a bug in which `find_package(example)` fails to locate the CMake module shipped by this project. See the upstream CMake documentation for `find_package` for details about which file basenames are accepted when searching for a CMake modules via `find_package`, but names like `example.cmake` are not on the search path and will not be discovered properly. Using `example-config.cmake` resolves this issue.
|
This sort of bug is difficult to test meaningfully inside the repo. It generally shows up when using this library from another project via packaging. I am working on Conan support in bemanproject/beman#21, which is how this bug was discovered. |
camio
approved these changes
Jul 2, 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 patch renames
example.cmaketoexample-config.cmake. This fixes a bug in whichfind_package(example)fails to locate the CMake module shipped by this project.See the upstream CMake documentation for
find_packagefor details about which file basenames are accepted when searching for a CMake modules viafind_package, but names likeexample.cmakeare not on the search path and will not be discovered properly.Using
example-config.cmakeresolves this issue.