summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-10-11 08:05:29 -0400
committerBrad King <brad.king@kitware.com>2019-10-11 08:05:29 -0400
commited06d27c7f0503a7d0d32d352d2e31bd4b82070e (patch)
tree246cb931504a84ba5b1199e386d272e94a244f41
parent1d9155eb9351120eadfa7d6386d0625b076d4be2 (diff)
downloadcmake-ed06d27c7f0503a7d0d32d352d2e31bd4b82070e.tar.gz
Help: Extend documentation of CMAKE_UNITY_BUILD variable
-rw-r--r--Help/variable/CMAKE_UNITY_BUILD.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/Help/variable/CMAKE_UNITY_BUILD.rst b/Help/variable/CMAKE_UNITY_BUILD.rst
index 3096954c20..b653881425 100644
--- a/Help/variable/CMAKE_UNITY_BUILD.rst
+++ b/Help/variable/CMAKE_UNITY_BUILD.rst
@@ -1,6 +1,8 @@
CMAKE_UNITY_BUILD
-----------------
-Default value for :prop_tgt:`UNITY_BUILD` of targets.
-
-By default ``CMAKE_UNITY_BUILD`` is ``OFF``.
+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.