diff options
| author | Craig Scott <craig.scott@crascit.com> | 2019-11-09 08:48:34 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2019-11-09 08:48:34 (GMT) |
| commit | fcacd8ce8d8843922bd2779f1774425433dfd9cc (patch) | |
| tree | 9e169d8c78e1e40b5608004631ae035c59b4c547 /Help/variable/CMAKE_UNITY_BUILD.rst | |
| parent | 929d7a454c8069bae4dece36838ed0db6b65d9cf (diff) | |
| download | CMake-fcacd8ce8d8843922bd2779f1774425433dfd9cc.zip CMake-fcacd8ce8d8843922bd2779f1774425433dfd9cc.tar.gz CMake-fcacd8ce8d8843922bd2779f1774425433dfd9cc.tar.bz2 | |
Help: Improve readability and fix inaccuracies in unity build docs
Diffstat (limited to 'Help/variable/CMAKE_UNITY_BUILD.rst')
| -rw-r--r-- | Help/variable/CMAKE_UNITY_BUILD.rst | 18 |
1 files changed, 13 insertions, 5 deletions
diff --git a/Help/variable/CMAKE_UNITY_BUILD.rst b/Help/variable/CMAKE_UNITY_BUILD.rst index bbcfd68..a86cd67 100644 --- a/Help/variable/CMAKE_UNITY_BUILD.rst +++ b/Help/variable/CMAKE_UNITY_BUILD.rst @@ -1,11 +1,19 @@ CMAKE_UNITY_BUILD ----------------- -Initializes the :prop_tgt:`UNITY_BUILD` target property on targets -as they are created. Set to ``ON`` to batch compilation of multiple -sources within each target. This feature is known as "Unity build", -or "Jumbo build". By default this variable is not set and so does -not enable unity builds on targets. +This variable is used to initialize the :prop_tgt:`UNITY_BUILD` +property of targets when they are created. Setting it to true +enables batch compilation of multiple sources within each target. +This feature is known as a *Unity* or *Jumbo* build. + +Projects should not set this variable, it is intended as a developer +control to be set on the :manual:`cmake(1)` command line or other +equivalent methods. The developer must have the ability to enable or +disable unity builds according to the capabilities of their own machine +and compiler. + +By default, this variable is not set, which will result in unity builds +being disabled. .. note:: This option currently does not work well in combination with |