summaryrefslogtreecommitdiff
path: root/Help/prop_tgt/UNITY_BUILD.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-10-11 08:05:59 -0400
committerBrad King <brad.king@kitware.com>2019-10-11 08:05:59 -0400
commit13c8dbd5a6bede4f3455203958238165437396e9 (patch)
treea14e991da142e16d5218d391cb911afd4b88badd /Help/prop_tgt/UNITY_BUILD.rst
parented06d27c7f0503a7d0d32d352d2e31bd4b82070e (diff)
downloadcmake-13c8dbd5a6bede4f3455203958238165437396e9.tar.gz
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/prop_tgt/UNITY_BUILD.rst')
-rw-r--r--Help/prop_tgt/UNITY_BUILD.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Help/prop_tgt/UNITY_BUILD.rst b/Help/prop_tgt/UNITY_BUILD.rst
index 1e68dcd29f..2faad92246 100644
--- a/Help/prop_tgt/UNITY_BUILD.rst
+++ b/Help/prop_tgt/UNITY_BUILD.rst
@@ -26,6 +26,12 @@ The batching of source files is done by adding new sources files
which will ``#include`` the source files, and exclude them from
building by setting :prop_sf:`HEADER_FILE_ONLY` to ``ON``.
+.. note::
+
+ Marking the original sources with :prop_sf:`HEADER_FILE_ONLY`
+ is considered an implementation detail that may change in the
+ future because it does not work well in combination with
+ the :variable:`CMAKE_EXPORT_COMPILE_COMMANDS` variable.
ODR (One definition rule) errors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^