summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-11-22 14:51:46 (GMT)
committerKitware Robot <kwrobot@kitware.com>2022-11-22 14:51:58 (GMT)
commit3d1f91a245fec409b93c4f059ca50efcff9af578 (patch)
tree9df792fc868d8f0083489669bc6f291a35a587b6
parent0a802d0f9ef2b0a0150382d6e988f5d2a78eeb64 (diff)
parent19fc1ba630e06f75fed8447999c2bef6439663c2 (diff)
downloadCMake-3d1f91a245fec409b93c4f059ca50efcff9af578.zip
CMake-3d1f91a245fec409b93c4f059ca50efcff9af578.tar.gz
CMake-3d1f91a245fec409b93c4f059ca50efcff9af578.tar.bz2
Merge topic 'cxxmodules-doc-msvc-modmapfmt' into release-3.25
19fc1ba630 Help/dev/experimental: document the `msvc` module map format Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !7944
-rw-r--r--Help/dev/experimental.rst9
1 files changed, 7 insertions, 2 deletions
diff --git a/Help/dev/experimental.rst b/Help/dev/experimental.rst
index 336137f..78770f7 100644
--- a/Help/dev/experimental.rst
+++ b/Help/dev/experimental.rst
@@ -76,8 +76,9 @@ For compilers that generate module maps, tell CMake as follows:
set(CMAKE_EXPERIMENTAL_CXX_MODULE_MAP_FLAG
"${compiler_flags_for_module_map} -fmodule-mapper=<MODULE_MAP_FILE>")
-Currently, the only supported format is ``gcc``. The format is described in
-the GCC documentation, but the relevant section for the purposes of CMake is:
+Currently, the only supported formats are ``gcc`` and ``msvc``. The ``gcc``
+format is described in the GCC documentation, but the relevant section for the
+purposes of CMake is:
A mapping file consisting of space-separated module-name, filename
pairs, one per line. Only the mappings for the direct imports and any
@@ -88,6 +89,10 @@ the GCC documentation, but the relevant section for the purposes of CMake is:
-- GCC module mapper documentation
+The ``msvc`` format is a response file containing flags required to compile
+any module interfaces properly as well as find any required files to satisfy
+``import`` statements as required for Microsoft's Visual Studio toolchains.
+
.. _`D1483r1`: https://mathstuf.fedorapeople.org/fortran-modules/fortran-modules.html
.. _`P1689r5`: http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p1689r5.html
.. _`cxx-modules-sandbox`: https://github.com/mathstuf/cxx-modules-sandbox