summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-10-11 12:05:59 (GMT)
committerBrad King <brad.king@kitware.com>2019-10-11 12:05:59 (GMT)
commit13c8dbd5a6bede4f3455203958238165437396e9 (patch)
treea14e991da142e16d5218d391cb911afd4b88badd /Help/variable
parented06d27c7f0503a7d0d32d352d2e31bd4b82070e (diff)
downloadCMake-13c8dbd5a6bede4f3455203958238165437396e9.zip
CMake-13c8dbd5a6bede4f3455203958238165437396e9.tar.gz
CMake-13c8dbd5a6bede4f3455203958238165437396e9.tar.bz2
Help: Document CMAKE_UNITY_BUILD/CMAKE_EXPORT_COMPILE_COMMANDS limitation
These two options currently do not work well together. Mention this limitation in the documentation. Issue: #19826
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst4
-rw-r--r--Help/variable/CMAKE_UNITY_BUILD.rst4
2 files changed, 8 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst b/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst
index 8776279..4548abc 100644
--- a/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst
+++ b/Help/variable/CMAKE_EXPORT_COMPILE_COMMANDS.rst
@@ -28,3 +28,7 @@ form. The format of the JSON file looks like:
.. note::
This option is implemented only by :ref:`Makefile Generators`
and the :generator:`Ninja`. It is ignored on other generators.
+
+ This option currently does not work well in combination with
+ the :prop_tgt:`UNITY_BUILD` target property or the
+ :variable:`CMAKE_UNITY_BUILD` variable.
diff --git a/Help/variable/CMAKE_UNITY_BUILD.rst b/Help/variable/CMAKE_UNITY_BUILD.rst
index b653881..bbcfd68 100644
--- a/Help/variable/CMAKE_UNITY_BUILD.rst
+++ b/Help/variable/CMAKE_UNITY_BUILD.rst
@@ -6,3 +6,7 @@ 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.
+
+.. note::
+ This option currently does not work well in combination with
+ the :variable:`CMAKE_EXPORT_COMPILE_COMMANDS` variable.