summaryrefslogtreecommitdiffstats
path: root/Help/prop_sf
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2019-11-09 08:48:34 (GMT)
committerCraig Scott <craig.scott@crascit.com>2019-11-09 08:48:34 (GMT)
commitfcacd8ce8d8843922bd2779f1774425433dfd9cc (patch)
tree9e169d8c78e1e40b5608004631ae035c59b4c547 /Help/prop_sf
parent929d7a454c8069bae4dece36838ed0db6b65d9cf (diff)
downloadCMake-fcacd8ce8d8843922bd2779f1774425433dfd9cc.zip
CMake-fcacd8ce8d8843922bd2779f1774425433dfd9cc.tar.gz
CMake-fcacd8ce8d8843922bd2779f1774425433dfd9cc.tar.bz2
Help: Improve readability and fix inaccuracies in unity build docs
Diffstat (limited to 'Help/prop_sf')
-rw-r--r--Help/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/Help/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst b/Help/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst
index 53f3970..6d1e60d 100644
--- a/Help/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst
+++ b/Help/prop_sf/SKIP_UNITY_BUILD_INCLUSION.rst
@@ -1,7 +1,11 @@
SKIP_UNITY_BUILD_INCLUSION
--------------------------
-Is this source file skipped by :prop_tgt:`UNITY_BUILD` feature.
+Setting this property to true ensures the source file will be skipped by
+unity builds when its associated target has its :prop_tgt:`UNITY_BUILD`
+property set to true. The source file will instead be compiled on its own
+in the same way as it would with unity builds disabled.
-This property helps with "ODR (One definition rule)" problems
-that one would run into when using an :prop_tgt:`UNITY_BUILD`.
+This property helps with "ODR (One definition rule)" problems where combining
+a particular source file with others might lead to build errors or other
+unintended side effects.