summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2024-05-29 12:31:56 (GMT)
committerKitware Robot <kwrobot@kitware.com>2024-05-29 12:32:08 (GMT)
commitbcfcb964ce8ca6c99d378d6df14ba8d3c7ce872e (patch)
tree5d9f5cdabfd1f05bb8650104a925afc32f0ee0c2
parent26befdb554e024620cec878c9e2efb163fd5a7fe (diff)
parent61e76200d7ee3b8ebb90c0cd25e4a5c5efd69e94 (diff)
downloadCMake-bcfcb964ce8ca6c99d378d6df14ba8d3c7ce872e.zip
CMake-bcfcb964ce8ca6c99d378d6df14ba8d3c7ce872e.tar.gz
CMake-bcfcb964ce8ca6c99d378d6df14ba8d3c7ce872e.tar.bz2
Merge topic 'doc-swift-module-dir-caveat'
61e76200d7 Help: Discourage use of Swift_MODULE_DIRECTORY with multi-config generators Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !9547
-rw-r--r--Help/prop_tgt/Swift_MODULE_DIRECTORY.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst b/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst
index 619377a..77f8311 100644
--- a/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst
+++ b/Help/prop_tgt/Swift_MODULE_DIRECTORY.rst
@@ -10,3 +10,15 @@ the modules will be placed. When this property is not set, the modules will be
placed in the build directory corresponding to the target's source directory.
If the variable :variable:`CMAKE_Swift_MODULE_DIRECTORY` is set when a target is
created its value is used to initialize this property.
+
+.. warning::
+
+ This property does not currently provide a way to express per-config
+ module directories, so use with multi-config generators is problematic:
+
+ * The :generator:`Xcode` generator does not implement the property at all.
+
+ * The :generator:`Ninja Multi-Config` generator implements this property,
+ but module files generated for different build configurations have the
+ same path, which can lead to subtle problems when building more than
+ one configuration.