summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2021-06-02 18:55:43 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2021-06-04 19:25:18 (GMT)
commit8d898cb3e10d6ad44bbe542b7b219a0b788b2a0d (patch)
treea51dcab0e25d6b932fe82450b3f660d682907993 /Help/manual
parent72f2448e82d8b3e90fa733cb6c631298083ae06b (diff)
downloadCMake-8d898cb3e10d6ad44bbe542b7b219a0b788b2a0d.zip
CMake-8d898cb3e10d6ad44bbe542b7b219a0b788b2a0d.tar.gz
CMake-8d898cb3e10d6ad44bbe542b7b219a0b788b2a0d.tar.bz2
FileAPI: Add integration for runtime dependency installers
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake-file-api.7.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/Help/manual/cmake-file-api.7.rst b/Help/manual/cmake-file-api.7.rst
index e7d78c3..5e22ea9 100644
--- a/Help/manual/cmake-file-api.7.rst
+++ b/Help/manual/cmake-file-api.7.rst
@@ -752,6 +752,12 @@ with members:
The ``destination`` member is populated. The ``isOptional`` member may
exist. This type has no additional members.
+ ``runtimeDependencySet``
+ An :command:`install(RUNTIME_DEPENDENCY_SET)` call or an
+ :command:`install(TARGETS)` call with ``RUNTIME_DEPENDENCIES``. The
+ ``destination`` member is populated. This type has additional members
+ ``runtimeDependencySetName`` and ``runtimeDependencySetType``.
+
``isExcludeFromAll``
Optional member that is present with boolean value ``true`` when
:command:`install` is called with the ``EXCLUDE_FROM_ALL`` option.
@@ -811,6 +817,24 @@ with members:
An unsigned integer 0-based index into the main "codemodel"
object's ``targets`` array for the target.
+ ``runtimeDependencySetName``
+ Optional member that is present when ``type`` is ``runtimeDependencySet``
+ and the installer was created by an
+ :command:`install(RUNTIME_DEPENDENCY_SET)` call. The value is a string
+ specifying the name of the runtime dependency set that was installed.
+
+ ``runtimeDependencySetType``
+ Optional member that is present when ``type`` is ``runtimeDependencySet``.
+ The value is a string with one of the following values:
+
+ ``library``
+ Indicates that this installer installs dependencies that are not macOS
+ frameworks.
+
+ ``framework``
+ Indicates that this installer installs dependencies that are macOS
+ frameworks.
+
``scriptFile``
Optional member that is present when ``type`` is ``script``.
The value is a string specifying the path to the script file on disk,