Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-14 02:08:27 +08:00
Code Issues Projects Releases Wiki Activity

Help: improve docs for rpath-related variables

Browse Source 
Now all RPATH-related variables link to the related
RPATH-related variables. Some also link to the
INSTALL_RPATH and BUILD_RPATH target properties.
This commit is contained in:
Alexander Neundorf
2023-01-10 22:54:42 +01:00
parent b2a6527f37
commit 099292f123
5 changed files with 25 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Help/variable/CMAKE_BUILD_WITH_INSTALL_RPATH.rst
View File

@@ -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.

3
Help/variable/CMAKE_NO_BUILTIN_CHRPATH.rst
View File

@@ -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

10
Help/variable/CMAKE_SKIP_BUILD_RPATH.rst
View File

@@ -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.

5
Help/variable/CMAKE_SKIP_INSTALL_RPATH.rst
View File

@@ -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.

6
Help/variable/CMAKE_SKIP_RPATH.rst
View File

@@ -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.