Help/dev/experimental: document the msvc module map format

This commit is contained in:
Ben Boeckel
2022-11-21 12:58:30 -05:00
parent 87f7553754
commit 19fc1ba630

View File

@@ -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