Skip to content

Opt in to the default CMake install path #994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 27, 2023
Merged

Opt in to the default CMake install path #994

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
48aa1e1
Allow user to opt in to the default CMake install path by setting -DU…
kkloberdanz Jul 26, 2023
54cb9ab
Update CMakeLists.txt
kkloberdanz Jul 27, 2023
5b87303
update docs to use -DUSE_DEFAULT_INSTALL_PATH=ON
kkloberdanz Jul 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,12 @@ To build static libraries only, set both BUILD_SHARED_LIBS and BUILD_SHARED_AND_
endif()


# If the user did not customize the install prefix,
# set it to live under build so we don't inadvertently pollute /usr/local
if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
option(USE_DEFAULT_INSTALL_PATH "Override the CMake default installation path" OFF)
if(NOT CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND USE_DEFAULT_INSTALL_PATH)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT is only TRUE on the very first execution of configure, so setting USE_DEFAULT_INSTALL_PATH=TRUE will trigger this branch on every subsequent configure, preventing it from succeeding until CMAKE_INSTALL_PREFIX is un-set on the CLI with -U.

message(FATAL_ERROR "You cannot set both CMAKE_INSTALL_PREFIX and USE_DEFAULT_INSTALL_PATH")
endif()
if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND NOT USE_DEFAULT_INSTALL_PATH)
message(WARNING "the CMake default install path is being overriden. This behavior will not be the default in a future release. Build with -DUSE_DEFAULT_INSTALL_PATH=ON to opt into what will be the default behavior in a future release")
set (CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/install" CACHE PATH "default install path" FORCE)
endif()
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update the Configure the driver steps in the install documentation to use the USE_DEFAULT_INSTALL_PATH option.


Expand Down