Help: improve docs for rpath-related variables

Now all RPATH-related variables link to the related
RPATH-related variables. Some also link to the
INSTALL_RPATH and BUILD_RPATH target properties.

5 files changed, 25 insertions, 2 deletions

diff --git a/Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst b/Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst
index 5b59a6e..839771a 100644
--- a/Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst
+++ b/Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst
@@ -9,3 +9,6 @@ installed the executables etc are relinked by CMake to have the
 install ``RPATH``.  If this variable is set to true then the software is
 always built with the install path for the ``RPATH`` and does not need to
 be relinked when installed.
+
+This is used to initialize the :prop_tgt:`BUILD_WITH_INSTALL_RPATH` target property
+for all targets.
diff --git a/Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst b/Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst
index b9b045e..483ec5f 100644
--- a/Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst
+++ b/Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst
@@ -10,6 +10,9 @@ a builtin editor to change the runtime search path in the installed copy.
 If this variable is set to true then CMake will relink the binary before
 installation instead of using its builtin editor.
 
+For more information on RPATH handling see
+the :prop_tgt:`INSTALL_RPATH` and :prop_tgt:`BUILD_RPATH` target properties.
+
 .. versionadded:: 3.20
 
   This variable also applies to XCOFF binaries' LIBPATH.  Prior to the
diff --git a/Help/variable/CMAKE_SKIP_BUILD_RPATH.rst b/Help/variable/CMAKE_SKIP_BUILD_RPATH.rst
index 8da6100..dd3e2a0 100644
--- a/Help/variable/CMAKE_SKIP_BUILD_RPATH.rst
+++ b/Help/variable/CMAKE_SKIP_BUILD_RPATH.rst
@@ -6,5 +6,13 @@ Do not include RPATHs in the build tree.
 Normally CMake uses the build tree for the RPATH when building
 executables etc on systems that use RPATH.  When the software is
 installed the executables etc are relinked by CMake to have the
-install RPATH.  If this variable is set to true then the software is
+install RPATH.  If this variable is set to ``TRUE`` then the software is
 always built with no RPATH.
+
+This is used to initialize the :prop_tgt:`SKIP_BUILD_RPATH` target property
+for all targets. For more information on RPATH handling see
+the :prop_tgt:`INSTALL_RPATH` and :prop_tgt:`BUILD_RPATH` target properties.
+
+See also the :variable:`CMAKE_SKIP_INSTALL_RPATH` variable.
+To omit RPATH in both the build and install steps, use
+:variable:`CMAKE_SKIP_RPATH` instead.
diff --git a/Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst b/Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst
index cc0ac21..465fdae 100644
--- a/Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst
+++ b/Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst
@@ -10,5 +10,10 @@ install RPATH.  If this variable is set to true then the software is
 always installed without RPATH, even if RPATH is enabled when
 building.  This can be useful for example to allow running tests from
 the build directory with RPATH enabled before the installation step.
+
+See also the :variable:`CMAKE_SKIP_BUILD_RPATH` variable.
 To omit RPATH in both the build and install steps, use
 :variable:`CMAKE_SKIP_RPATH` instead.
+
+For more information on RPATH handling see the :prop_tgt:`INSTALL_RPATH`
+and :prop_tgt:`BUILD_RPATH` target properties.
diff --git a/Help/variable/CMAKE_SKIP_RPATH.rst b/Help/variable/CMAKE_SKIP_RPATH.rst
index d7ce8e4..43f6401 100644
--- a/Help/variable/CMAKE_SKIP_RPATH.rst
+++ b/Help/variable/CMAKE_SKIP_RPATH.rst
@@ -7,4 +7,8 @@ If this is set to ``TRUE``, then the rpath information is not added to
 compiled executables.  The default is to add rpath information if the
 platform supports it.  This allows for easy running from the build
 tree.  To omit RPATH in the install step, but not the build step, use
-:variable:`CMAKE_SKIP_INSTALL_RPATH` instead.
+:variable:`CMAKE_SKIP_INSTALL_RPATH` instead. To omit RPATH in the build step,
+use :variable:`CMAKE_SKIP_BUILD_RPATH`.
+
+For more information on RPATH handling see the :prop_tgt:`INSTALL_RPATH`
+and :prop_tgt:`BUILD_RPATH` target properties.