summaryrefslogtreecommitdiff
path: root/Help/command/install.rst
diff options
context:
space:
mode:
authorNils Gladitz <n.gladitz@abberior-instruments.com>2021-05-19 10:15:16 +0200
committerNils Gladitz <n.gladitz@abberior-instruments.com>2021-05-19 19:17:58 +0200
commit99ff75455ece5ec4add771a2de93b237ab858d08 (patch)
tree49f27c52bcec9b415c054ac80d3643fa03756a33 /Help/command/install.rst
parent82fd8b6ba36658705fc55bc40df0b6b6ec80b773 (diff)
downloadcmake-99ff75455ece5ec4add771a2de93b237ab858d08.tar.gz
install: Implement new install(CODE|SCRIPT) option ALL_COMPONENTS
In a per-component installation the generated installation scripts are invoked once for each component. Per default custom installation script code added by install(CODE|SCRIPT) only runs for one specific component in this context. The new ALL_COMPONENTS option allows custom script code to be run once for each component being installed.
Diffstat (limited to 'Help/command/install.rst')
-rw-r--r--Help/command/install.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/Help/command/install.rst b/Help/command/install.rst
index 993cf7f3f3..2259176d74 100644
--- a/Help/command/install.rst
+++ b/Help/command/install.rst
@@ -619,7 +619,7 @@ Custom Installation Logic
.. code-block:: cmake
install([[SCRIPT <file>] [CODE <code>]]
- [COMPONENT <component>] [EXCLUDE_FROM_ALL] [...])
+ [COMPONENT <component>] [EXCLUDE_FROM_ALL] [ALL_COMPONENTS] [...])
The ``SCRIPT`` form will invoke the given CMake script files during
installation. If the script file name is a relative path it will be
@@ -634,6 +634,12 @@ example, the code
will print a message during installation.
+The option ``ALL_COMPONENTS``
+ .. versionadded:: 3.21
+
+ Run the custom installation script code for every component of a
+ component-specific installation.
+
.. versionadded:: 3.14
``<file>`` or ``<code>`` may use "generator expressions" with the syntax
``$<...>`` (in the case of ``<file>``, this refers to their use in the file