Help: Clarify INSTALL_RPATH_USE_LINK_PATH documentation

State explicitly that directories containing linked library files
are also included even if they are not in the linker search path.
This commit is contained in:
Hong Xu
2019-12-02 13:21:00 -08:00
committed by Brad King
parent 735d731119
commit fb4a39a900
2 changed files with 17 additions and 9 deletions

View File

@@ -3,8 +3,12 @@ INSTALL_RPATH_USE_LINK_PATH
Add paths to linker search and installed rpath. Add paths to linker search and installed rpath.
``INSTALL_RPATH_USE_LINK_PATH`` is a boolean that if set to ``True`` will ``INSTALL_RPATH_USE_LINK_PATH`` is a boolean that if set to ``True``
append directories in the linker search path and outside the project will append to the runtime search path (rpath) of installed binaries
to the :prop_tgt:`INSTALL_RPATH`. This property is initialized by the value of any directories outside the project that are in the linker search path or
the variable ``CMAKE_INSTALL_RPATH_USE_LINK_PATH`` if it is set when a contain linked library files. The directories are appended after the
target is created. value of the :prop_tgt:`INSTALL_RPATH` target property.
This property is initialized by the value of the variable
:variable:`CMAKE_INSTALL_RPATH_USE_LINK_PATH` if it is set when a target is
created.

View File

@@ -3,7 +3,11 @@ CMAKE_INSTALL_RPATH_USE_LINK_PATH
Add paths to linker search and installed rpath. Add paths to linker search and installed rpath.
``CMAKE_INSTALL_RPATH_USE_LINK_PATH`` is a boolean that if set to ``true`` ``CMAKE_INSTALL_RPATH_USE_LINK_PATH`` is a boolean that if set to ``True``
will append directories in the linker search path and outside the will append to the runtime search path (rpath) of installed binaries
project to the :prop_tgt:`INSTALL_RPATH`. This is used to initialize the any directories outside the project that are in the linker search path or
target property :prop_tgt:`INSTALL_RPATH_USE_LINK_PATH` for all targets. contain linked library files. The directories are appended after the
value of the :prop_tgt:`INSTALL_RPATH` target property.
This varibale is used to initialize the target property
:prop_tgt:`INSTALL_RPATH_USE_LINK_PATH` for all targets.