Help: add documentation for the new TARGET_RUNTIME_DLL_DIRS genex

This commit is contained in:
Alexander Neundorf
2023-02-26 16:36:57 +01:00
parent c351dcd967
commit 2ce3d62ffb

View File

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