summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorAlexander Neundorf <neundorf@kde.org>2023-02-26 15:36:57 (GMT)
committerAlexander Neundorf <neundorf@kde.org>2023-02-26 15:36:57 (GMT)
commit2ce3d62ffb5cf75cad23f7aeac59b4acc586c22f (patch)
tree6dd11aaf7076e039956d9560e9df8a42c8bf8586 /Help
parentc351dcd967379644db65e62534e73f874b16b4a3 (diff)
downloadCMake-2ce3d62ffb5cf75cad23f7aeac59b4acc586c22f.zip
CMake-2ce3d62ffb5cf75cad23f7aeac59b4acc586c22f.tar.gz
CMake-2ce3d62ffb5cf75cad23f7aeac59b4acc586c22f.tar.bz2
Help: add documentation for the new TARGET_RUNTIME_DLL_DIRS genex
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-generator-expressions.7.rst18
1 files changed, 17 insertions, 1 deletions
diff --git a/Help/manual/cmake-generator-expressions.7.rst b/Help/manual/cmake-generator-expressions.7.rst
index c3e87d7..b642557 100644
--- a/Help/manual/cmake-generator-expressions.7.rst
+++ b/Help/manual/cmake-generator-expressions.7.rst
@@ -1668,7 +1668,9 @@ In the following, the phrase "the ``tgt`` filename" means the name of the
List of DLLs that the target depends on at runtime. This is determined by
the locations of all the ``SHARED`` targets in the target's transitive
- dependencies. Using this generator expression on targets other than
+ dependencies. If only the directories of the DLLs are needed, see the
+ :genex:`TARGET_RUNTIME_DLL_DIRS` generator expression.
+ Using this generator expression on targets other than
executables, ``SHARED`` libraries, and ``MODULE`` libraries is an error.
**On non-DLL platforms, this expression always evaluates to an empty string**.
@@ -1700,6 +1702,20 @@ On platforms that support runtime paths (``RPATH``), refer to the
:prop_tgt:`INSTALL_RPATH` target property.
On Apple platforms, refer to the :prop_tgt:`INSTALL_NAME_DIR` target property.
+.. genex:: $<TARGET_RUNTIME_DLL_DIRS:tgt>
+
+ .. versionadded:: 3.27
+
+ List of the directories which contain the DLLs that the target depends on at
+ runtime (see :genex:`TARGET_RUNTIME_DLLS`). This is determined by
+ the locations of all the ``SHARED`` targets in the target's transitive
+ dependencies. Using this generator expression on targets other than
+ executables, ``SHARED`` libraries, and ``MODULE`` libraries is an error.
+ **On non-DLL platforms, this expression always evaluates to an empty string**.
+
+ This generator expression can e.g. be used to create a batch file using
+ :command:`file(GENERATE)` which sets the PATH environment variable accordingly.
+
Export And Install Expressions
------------------------------