diff options
| author | Brad King <brad.king@kitware.com> | 2015-11-02 14:09:55 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2015-11-02 14:09:55 (GMT) |
| commit | 2aaf702dec9cd3d846643abffae0d4f1cb2f2702 (patch) | |
| tree | 5d2905c31e32488ade73c7ff052515ab37076711 | |
| parent | 9d1c77cfdace4250438cd449304ea013f950cf61 (diff) | |
| parent | f8eb72fe5fedbf45e66f433e6bc54e1cf0359760 (diff) | |
| download | CMake-2aaf702dec9cd3d846643abffae0d4f1cb2f2702.zip CMake-2aaf702dec9cd3d846643abffae0d4f1cb2f2702.tar.gz CMake-2aaf702dec9cd3d846643abffae0d4f1cb2f2702.tar.bz2 | |
Merge topic 'macosx_rpath-clarify-doc'
f8eb72fe Help: Clarify documentation for MACOSX_RPATH variable.
| -rw-r--r-- | Help/prop_tgt/MACOSX_RPATH.rst | 15 |
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 |