Add CMake imported target for docopt library #159
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
Using a separate build directory is a very common way of using CMake so add an ignore pattern for those.
eaaltonen
commented
Oct 17, 2022
| DESTINATION "${CMAKE_INSTALL_LIBDIR}/${ConfigPackageLocation}") | ||
| install(EXPORT ${export_name} | ||
| DESTINATION "${CMAKE_INSTALL_LIBDIR}/${ConfigPackageLocation}" | ||
| NAMESPACE Docopt::) |
There was a problem hiding this comment.
Regarding the name:
- is current
Docopt::docoptgood - should it be
Docopt.cpp::docopt - something else ?
eaaltonen
commented
Oct 17, 2022
| install(FILES docopt-config.cmake ${PROJECT_BINARY_DIR}/docopt-config-version.cmake DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/docopt") | ||
| install(EXPORT ${export_name} DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/docopt") | ||
| set(ConfigPackageLocation "cmake/docopt") | ||
| # Unix layout, ref https://cmake.org/cmake/help/latest/command/find_package.html#config-mode-search-procedure |
There was a problem hiding this comment.
There's at least two valid choices here, so I'd like to check the project author's preference here:
- unix layout (current)
- picking a layout according the current / specified OS.
Write our CMake config-file package using the `configure_package_config_file` function defined in CMakePackageConfigHelpers.cmake and export our library in a namespace so that it can be used as an imported target.
With the alias, the `Docopt::docopt` target can be linked to regardless of whether the consuming project uses `find_package` or `add_subdirectory`.
eaaltonen
force-pushed
the
add-imported-target
branch
from
01ad933 to
1ea7bd5
Compare
|
added missing newline to |
|
@jaredgrubb : if you could take a look? I will be submitting packaging to Buildroot soonish. |
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 writes the CMake config-file package using CMakePackageConfigHelpers and exports the target as a
Docopt::docoptimported target.This allows developers to install and use the library without necessarily requiring
rootpermission by:-DCMAKE_INSTALL_PREFIX="${HOME}/wherever"-DCMAKE_PREFIX_PATH="${HOME}/wherever"and linking to imported targetDocopt::docopt.Keeping in mind the newly released FetchContent and find_package() integration, also add an alias target so that
Docopt::docoptcan be linked to regardless of whether the build uses a prebuilt package or fetches the sources.