kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge topic 'macosx_rpath-clarify-doc' 

f8eb72fe Help: Clarify documentation for MACOSX_RPATH variable.
This commit is contained in:
Brad King 2015-11-02 09:09:55 -05:00 committed by CMake Topic Stage
parent 9d1c77cfda f8eb72fe5f
commit 2aaf702dec
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Help/prop_tgt/MACOSX_RPATH.rst
View File

@ -1,17 +1,22 @@
MACOSX_RPATH 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 When this property is set to true, the directory portion of
the "install_name" field of shared libraries will be ``@rpath`` the "install_name" field of this shared library will be ``@rpath``
unless overridden by :prop_tgt:`INSTALL_NAME_DIR`. Runtime unless overridden by :prop_tgt:`INSTALL_NAME_DIR`. This indicates
paths will also be embedded in binaries using this target and the shared library is to be found at runtime using runtime
can be controlled by the :prop_tgt:`INSTALL_RPATH` target property. paths (rpaths).
This property is initialized by the value of the variable This property is initialized by the value of the variable
:variable:`CMAKE_MACOSX_RPATH` if it is set when a target is :variable:`CMAKE_MACOSX_RPATH` if it is set when a target is
created. 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 Policy CMP0042 was introduced to change the default value of
MACOSX_RPATH to ON. This is because use of ``@rpath`` is a MACOSX_RPATH to ON. This is because use of ``@rpath`` is a
more flexible and powerful alternative to ``@executable_path`` and more flexible and powerful alternative to ``@executable_path`` and