diff options
| author | Craig Scott <craig.scott@crascit.com> | 2021-06-29 17:25:19 +1000 |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2021-07-03 17:10:09 +1000 |
| commit | 308e5b30c900cb4aa1009ee8e25908a41060d992 (patch) | |
| tree | c4a0126afbdf16a622b2de5c5de6a126078e8136 | |
| parent | 52dec01729c2afc0f4ffc04286ac5aec043e35aa (diff) | |
| download | cmake-308e5b30c900cb4aa1009ee8e25908a41060d992.tar.gz | |
Help: Tighten install(SCRIPT) wording for ALL_COMPONENTS option
In particular, mention the mutually exclusive nature with the
COMPONENT option. Fix the inconsistent way the versionadded
details were added for that text too.
| -rw-r--r-- | Help/command/install.rst | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/Help/command/install.rst b/Help/command/install.rst index acfaa486d1..ace53b3f90 100644 --- a/Help/command/install.rst +++ b/Help/command/install.rst @@ -693,7 +693,8 @@ Custom Installation Logic .. code-block:: cmake install([[SCRIPT <file>] [CODE <code>]] - [COMPONENT <component>] [EXCLUDE_FROM_ALL] [ALL_COMPONENTS] [...]) + [ALL_COMPONENTS | COMPONENT <component>] + [EXCLUDE_FROM_ALL] [...]) The ``SCRIPT`` form will invoke the given CMake script files during installation. If the script file name is a relative path it will be @@ -708,11 +709,11 @@ 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.21 + When the ``ALL_COMPONENTS`` option is given, the custom installation + script code will be executed for every component of a component-specific + installation. This option is mutually exclusive with the ``COMPONENT`` + option. .. versionadded:: 3.14 ``<file>`` or ``<code>`` may use "generator expressions" with the syntax |