Browse Source

Merge topic 'cxxmodules-doc-msvc-modmapfmt' into release-3.25

19fc1ba630 Help/dev/experimental: document the `msvc` module map format

Acked-by: Kitware Robot <[email protected]>
Merge-request: !7944
Brad King 3 years ago
parent
commit
3d1f91a245
1 changed files with 7 additions and 2 deletions
  1. 7 2
      Help/dev/experimental.rst

+ 7 - 2
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