summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-02-14 13:51:37 (GMT)
committerBrad King <brad.king@kitware.com>2017-02-14 13:52:02 (GMT)
commit624fb9d7175ee011f8a86c8d7614be4806a53184 (patch)
tree198d574c2e2f1355b849ab48aff13600f85ee8ea /Help
parent46c6489850ca9029bb75d17ed652563fc58a0082 (diff)
downloadCMake-624fb9d7175ee011f8a86c8d7614be4806a53184.zip
CMake-624fb9d7175ee011f8a86c8d7614be4806a53184.tar.gz
CMake-624fb9d7175ee011f8a86c8d7614be4806a53184.tar.bz2
Help: Format BUILD_WITH_INSTALL_RPATH documentation
Diffstat (limited to 'Help')
-rw-r--r--Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst b/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst
index abcf28f..35297e9 100644
--- a/Help/prop_tgt/BUILD_WITH_INSTALL_RPATH.rst
+++ b/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.