summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Abrahams <dabrahams@adobe.com>2024-05-23 17:33:25 (GMT)
committerBrad King <brad.king@kitware.com>2024-05-28 15:24:33 (GMT)
commit61e76200d7ee3b8ebb90c0cd25e4a5c5efd69e94 (patch)
treebcca72cc3eb537ee5bfe261c63d4f37e6880c9a2
parent71c52c76faf3f5d26e65ea0855fd1bffd51b0bb8 (diff)
downloadCMake-61e76200d7ee3b8ebb90c0cd25e4a5c5efd69e94.zip
CMake-61e76200d7ee3b8ebb90c0cd25e4a5c5efd69e94.tar.gz
CMake-61e76200d7ee3b8ebb90c0cd25e4a5c5efd69e94.tar.bz2
Help: Discourage use of Swift_MODULE_DIRECTORY with multi-config generators
It does not yet support per-config module directories. Issue: #25989 Issue: #26010
-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.