summaryrefslogtreecommitdiffstats
path: root/Help/prop_tgt/MACOSX_RPATH.rst
diff options
context:
space:
mode:
authorClinton Stimpson <clinton@elemtech.com>2015-11-02 13:46:02 (GMT)
committerClinton Stimpson <clinton@elemtech.com>2015-11-02 13:46:02 (GMT)
commitf8eb72fe5fedbf45e66f433e6bc54e1cf0359760 (patch)
treedf2b94239f8873db3e1e9af4832ef16de9a5709d /Help/prop_tgt/MACOSX_RPATH.rst
parent2f269fdf0c293e80325c748c985279bc4067af3e (diff)
downloadCMake-f8eb72fe5fedbf45e66f433e6bc54e1cf0359760.zip
CMake-f8eb72fe5fedbf45e66f433e6bc54e1cf0359760.tar.gz
CMake-f8eb72fe5fedbf45e66f433e6bc54e1cf0359760.tar.bz2
Help: Clarify documentation for MACOSX_RPATH variable.
Diffstat (limited to 'Help/prop_tgt/MACOSX_RPATH.rst')
-rw-r--r--Help/prop_tgt/MACOSX_RPATH.rst15
1 files changed, 10 insertions, 5 deletions
diff --git a/Help/prop_tgt/MACOSX_RPATH.rst b/Help/prop_tgt/MACOSX_RPATH.rst
index d3934ba..1c503d1 100644
--- a/Help/prop_tgt/MACOSX_RPATH.rst
+++ b/Help/prop_tgt/MACOSX_RPATH.rst
@@ -1,17 +1,22 @@
MACOSX_RPATH
------------
-Whether to use rpaths on Mac OS X.
+Whether this target on Mac OS X is located at runtime using rpaths.
When this property is set to true, the directory portion of
-the "install_name" field of shared libraries will be ``@rpath``
-unless overridden by :prop_tgt:`INSTALL_NAME_DIR`. Runtime
-paths will also be embedded in binaries using this target and
-can be controlled by the :prop_tgt:`INSTALL_RPATH` target property.
+the "install_name" field of this shared library will be ``@rpath``
+unless overridden by :prop_tgt:`INSTALL_NAME_DIR`. This indicates
+the shared library is to be found at runtime using runtime
+paths (rpaths).
+
This property is initialized by the value of the variable
:variable:`CMAKE_MACOSX_RPATH` if it is set when a target is
created.
+Runtime paths will also be embedded in binaries using this target and
+can be controlled by the :prop_tgt:`INSTALL_RPATH` target property on
+the target linking to this target.
+
Policy CMP0042 was introduced to change the default value of
MACOSX_RPATH to ON. This is because use of ``@rpath`` is a
more flexible and powerful alternative to ``@executable_path`` and