summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2019-11-04 06:02:57 (GMT)
committerCraig Scott <craig.scott@crascit.com>2019-11-04 06:02:57 (GMT)
commitdd05ef429ab9f2d0377efba7a2bca1bb7181dc2f (patch)
tree1a408514106addac490824cef48a2faa060d9bcd /Help/variable
parentac8de0dbcfdefa431e4a32c4fd469cb5ac83af36 (diff)
downloadCMake-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/variable')
-rw-r--r--Help/variable/CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/Help/variable/CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH.rst b/Help/variable/CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH.rst
index 19ae5f3..76ca3da 100644
--- a/Help/variable/CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH.rst
+++ b/Help/variable/CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH.rst
@@ -1,9 +1,9 @@
CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH
--------------------------------------
-Removes compiler defined rpaths durimg installation.
+Sets the default for whether toolchain-defined rpaths should be removed during
+installation.
-``CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH`` is a boolean that if set to ``true``
-removes compiler defined rpaths from the project if the user also defines rpath
-with :prop_tgt:`INSTALL_RPATH`. This is used to initialize the target property
-:prop_tgt:`INSTALL_REMOVE_ENVIRONMENT_RPATH` for all targets.
+``CMAKE_INSTALL_REMOVE_ENVIRONMENT_RPATH`` is a boolean that provides the
+default value for the :prop_tgt:`INSTALL_REMOVE_ENVIRONMENT_RPATH` property
+of all subsequently created targets.