Add uninstall target #366
Merged
Add uninstall target #366
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
Satisfy the OpenSSF Best Practices Badge requirement for an insta/uninstall process: https://www.bestpractices.dev/en/criteria/1#1.installation_common CMake does not support a standard "uninstall" target, but the community recommends implementing an "uninstal" target that remove files named in the `install_manifest.txt`: https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake However, our existing process of installing the symlink to the "bare" library, i.e. the symlink from libImath-3_2.so to libImath.so, fails to add the symlink to the manifest, so "make uninstall" misses the symlink. The existing mechanism uses "install(CODE execute_process(cmake -E create_symlink))". This changes that to use a simpler "file(CREATE_LINK)" and "install(FILES)" to accomplish the same thing while also registering the symlink the the manifest. This change also adds the cmake option `IMATH_INSTALL`, on by default and for normal usage, but which allows disabling of the installation when Imath is configured as a subproject of another project. OpenEXR propgates the `OPENEXR_INSTALL` option to `IMATH_INSTALL`. Signed-off-by: Cary Phillips <[email protected]>
I haven't seen this pattern in other projects, I think I missed the motivation when it was introduced upstream at OpenEXR? |
|
It's needed by the python bindings because the cmake target that installs the wheels should not install the libraries, so this option makes it possible to suppress installing the libraries. Imath needs it, too, otherwise the OpenEXR target that installs the wheels would also install the Imath library. |
|
Gotcha, lgtm! |
meshula
approved these changes
Feb 12, 2024
cary-ilm
added a commit
to cary-ilm/Imath
that referenced
this pull request
Feb 16, 2024
Satisfy the OpenSSF Best Practices Badge requirement for an insta/uninstall process: https://www.bestpractices.dev/en/criteria/1#1.installation_common CMake does not support a standard "uninstall" target, but the community recommends implementing an "uninstal" target that remove files named in the `install_manifest.txt`: https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake However, our existing process of installing the symlink to the "bare" library, i.e. the symlink from libImath-3_2.so to libImath.so, fails to add the symlink to the manifest, so "make uninstall" misses the symlink. The existing mechanism uses "install(CODE execute_process(cmake -E create_symlink))". This changes that to use a simpler "file(CREATE_LINK)" and "install(FILES)" to accomplish the same thing while also registering the symlink the the manifest. This change also adds the cmake option `IMATH_INSTALL`, on by default and for normal usage, but which allows disabling of the installation when Imath is configured as a subproject of another project. OpenEXR propgates the `OPENEXR_INSTALL` option to `IMATH_INSTALL`. Signed-off-by: Cary Phillips <[email protected]>
cary-ilm
added a commit
to cary-ilm/Imath
that referenced
this pull request
Feb 22, 2024
This should have gone into PR AcademySoftwareFoundation#366, since `file(CREATE_LINK)` was introduced in cmake 3.14, not sure how it slipped through the CI. Signed-off-by: Cary Phillips <[email protected]>
cary-ilm
added a commit
that referenced
this pull request
Feb 29, 2024
This should have gone into PR #366, since `file(CREATE_LINK)` was introduced in cmake 3.14, not sure how it slipped through the CI. Signed-off-by: Cary Phillips <[email protected]>
cary-ilm
added a commit
to cary-ilm/Imath
that referenced
this pull request
Mar 13, 2024
This part of AcademySoftwareFoundation#366, backported for the 3.1 branch. Signed-off-by: Cary Phillips <[email protected]>
cary-ilm
added a commit
to cary-ilm/Imath
that referenced
this pull request
Mar 13, 2024
This part of AcademySoftwareFoundation#366, backported for the 3.1 branch. Signed-off-by: Cary Phillips <[email protected]>
cary-ilm
added a commit
that referenced
this pull request
Mar 14, 2024
This part of #366, backported for the 3.1 branch. Signed-off-by: Cary Phillips <[email protected]>
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.
Satisfy the OpenSSF Best Practices Badge requirement for an insta/uninstall process:
https://www.bestpractices.dev/en/criteria/1#1.installation_common
CMake does not support a standard "uninstall" target, but the community recommends implementing an "uninstal" target that remove files named in the
install_manifest.txt:https://gitlab.kitware.com/cmake/community/-/wikis/FAQ#can-i-do-make-uninstall-with-cmake
However, our existing process of installing the symlink to the "bare" library, i.e. the symlink from libImath-3_2.so to libImath.so, fails to add the symlink to the manifest, so "make uninstall" misses the symlink. The existing mechanism uses "install(CODE execute_process(cmake -E create_symlink))".
This changes that to use a simpler "file(CREATE_LINK)" and "install(FILES)" to accomplish the same thing while also registering the symlink the the manifest.
This change also adds the cmake option
IMATH_INSTALL, on by default and for normal usage, but which allows disabling of the installation when Imath is configured as a subproject of another project. OpenEXR propgates theOPENEXR_INSTALLoption toIMATH_INSTALL.