Browse Source

Help: Format BUILD_WITH_INSTALL_RPATH documentation

Brad King 9 years ago
parent
commit
624fb9d717
1 changed files with 7 additions and 7 deletions
  1. 7 7
      Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst

+ 7 - 7
Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst

@@ -1,11 +1,11 @@
 BUILD_WITH_INSTALL_RPATH
 ------------------------
 
-Should build tree targets have install tree rpaths.
+``BUILD_WITH_INSTALL_RPATH`` is a boolean specifying whether to link the target
+in the build tree with the :prop_tgt:`INSTALL_RPATH`.  This takes precedence
+over :prop_tgt:`SKIP_BUILD_RPATH` and avoids the need for relinking before
+installation.
 
-BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link the
-target in the build tree with the INSTALL_RPATH.  This takes
-precedence over SKIP_BUILD_RPATH and avoids the need for relinking
-before installation.  This property is initialized by the value of the
-variable CMAKE_BUILD_WITH_INSTALL_RPATH if it is set when a target is
-created.
+This property is initialized by the value of the
+:variable:`CMAKE_BUILD_WITH_INSTALL_RPATH` variable if it is set when a target
+is created.