summaryrefslogtreecommitdiff
path: root/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst
diff options
context:
space:
mode:
authorHong Xu <hong@topbug.net>2019-12-02 13:21:00 -0800
committerBrad King <brad.king@kitware.com>2019-12-05 12:45:45 -0500
commitfb4a39a900c7d7e2ef45194f89456ac60ebefe9e (patch)
tree92693ace8fb1ec86f849a41de6fdd6cd27b35da4 /Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst
parent735d731119e731c8a321f85824ee685005b38731 (diff)
downloadcmake-fb4a39a900c7d7e2ef45194f89456ac60ebefe9e.tar.gz
Help: Clarify INSTALL_RPATH_USE_LINK_PATH documentation
State explicitly that directories containing linked library files are also included even if they are not in the linker search path.
Diffstat (limited to 'Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst')
-rw-r--r--Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst14
1 files changed, 9 insertions, 5 deletions
diff --git a/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst b/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst
index d8be9548a3..d16a7a1c61 100644
--- a/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst
+++ b/Help/prop_tgt/INSTALL_RPATH_USE_LINK_PATH.rst
@@ -3,8 +3,12 @@ INSTALL_RPATH_USE_LINK_PATH
Add paths to linker search and installed rpath.
-``INSTALL_RPATH_USE_LINK_PATH`` is a boolean that if set to ``True`` will
-append directories in the linker search path and outside the project
-to the :prop_tgt:`INSTALL_RPATH`. This property is initialized by the value of
-the variable ``CMAKE_INSTALL_RPATH_USE_LINK_PATH`` if it is set when a
-target is created.
+``INSTALL_RPATH_USE_LINK_PATH`` is a boolean that if set to ``True``
+will append to the runtime search path (rpath) of installed binaries
+any directories outside the project that are in the linker search path or
+contain linked library files. The directories are appended after the
+value of the :prop_tgt:`INSTALL_RPATH` target property.
+
+This property is initialized by the value of the variable
+:variable:`CMAKE_INSTALL_RPATH_USE_LINK_PATH` if it is set when a target is
+created.