Browse Source

Help: Clarify documentation for MACOSX_RPATH variable.

Clinton Stimpson 10 years ago
parent
commit
f8eb72fe5f
1 changed files with 10 additions and 5 deletions
  1. 10 5
      Help/prop_tgt/MACOSX_RPATH.rst

+ 10 - 5
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