diff options
| author | Craig Scott <craig.scott@crascit.com> | 2019-11-04 06:02:57 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2019-11-04 06:02:57 (GMT) |
| commit | dd05ef429ab9f2d0377efba7a2bca1bb7181dc2f (patch) | |
| tree | 1a408514106addac490824cef48a2faa060d9bcd /Help/prop_tgt | |
| parent | ac8de0dbcfdefa431e4a32c4fd469cb5ac83af36 (diff) | |
| download | CMake-dd05ef429ab9f2d0377efba7a2bca1bb7181dc2f.zip CMake-dd05ef429ab9f2d0377efba7a2bca1bb7181dc2f.tar.gz CMake-dd05ef429ab9f2d0377efba7a2bca1bb7181dc2f.tar.bz2 | |
Help: Fix inaccuracies in INSTALL_REMOVE_ENVIRONMENT_RPATH docs
The previous docs assumed one had to set INSTALL_RPATH for
this target property to have an effect, but the actual condition is
only that the install rpath is different to the build rpath. Even if
the install rpath is empty, it is possible that CMake will rewrite
the rpath during install because the build rpath could be
non-empty.
Diffstat (limited to 'Help/prop_tgt')
| -rw-r--r-- | Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst b/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst index a474fc6..72dcaa0 100644 --- a/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst +++ b/Help/prop_tgt/INSTALL_REMOVE_ENVIRONMENT_RPATH.rst @@ -1,10 +1,16 @@ INSTALL_REMOVE_ENVIRONMENT_RPATH -------------------------------- -Removes compiler defined rpaths durimg installation. +Controls whether toolchain-defined rpaths should be removed during installation. -``INSTALL_REMOVE_ENVIRONMENT_RPATH`` is a boolean that if set to ``True`` will -remove compiler defined rpaths from the project if the user also defines rpath -with :prop_tgt:`INSTALL_RPATH`. This property is initialized by whether the -value of :variable:`CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH` is set when a -target is created. +When a target is being installed, CMake may need to rewrite its rpath +information. This occurs when the install rpath (as specified by the +:prop_tgt:`INSTALL_RPATH` target property) has different contents to the rpath +that the target was built with. Some toolchains insert their own rpath +contents into the binary as part of the build. By default, CMake will +preserve those extra inserted contents in the install rpath. For those +scenarios where such toolchain-inserted entries need to be discarded during +install, set the ``INSTALL_REMOVE_ENVIRONMENT_RPATH`` target property to true. + +This property is initialized by the value of +:variable:`CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH` when the target is created. |