Add note on install_manifest.txt to usage.rst #996
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
|
What does the install_manifest look like in superbuilds? Is it in subdirectories? |
Yes (related: https://github.com/orgs/scikit-build/discussions/997) |
jcfr
reviewed
Jul 16, 2023
jcfr
reviewed
Jul 16, 2023
| Compiled targets and other install files are identified by parsing the CMake-generated | ||
| ``install_manifest.txt`` file from :func:`skbuild.constants.CMAKE_BUILD_DIR()`. Note: | ||
| if scikit-build is driving nested CMake projects (externalproject / "superbuild"), the | ||
| manifest file may not be present in the ``CMAKE_BUILD_DIR``. |
There was a problem hiding this comment.
The way to currently deal with this is to explicitly include the cmake_install.cmake by adding code like the following in the outer project:
#-----------------------------------------------------------------------------
# Install inner project
message(STATUS "Adding install rules for inner project")
install(CODE "
include(\"${CMAKE_BINARY_DIR}/inner-build/cmake_install.cmake\")
")Notes:
- Make sure to tweak
${CMAKE_BINARY_DIR}/inner-buildbased on your project. - It may be possible to generalize this to include
cmake_install.cmakefrom other projects also built usingExternalProject...
Co-authored-by: Jean-Christophe Fillion-Robin <jchris.fillionr@kitware.com>
Codecov Report
@@ Coverage Diff @@
## main #996 +/- ##
=======================================
Coverage 86.26% 86.26%
=======================================
Files 33 33
Lines 1587 1587
Branches 350 350
=======================================
Hits 1369 1369
Misses 155 155
Partials 63 63 |
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.
Add a note on how skbuild uses install_manifest, and warn that EPs can be problematic (no install_manifest in the expected directory -> no module in the wheel). #997