summaryrefslogtreecommitdiffstats
path: root/Help/prop_sf
diff options
context:
space:
mode:
authorBen Boeckel <ben.boeckel@kitware.com>2022-11-17 18:50:24 (GMT)
committerBen Boeckel <ben.boeckel@kitware.com>2022-11-18 12:54:31 (GMT)
commita02d792c6e9bf9200ab652db6b6da415d80b578c (patch)
tree6c9d224ad9d3f53ca53cbf0e51b7092834c4308d /Help/prop_sf
parent008c09d6db60f7c24781b47414ffa26edbd0e22d (diff)
downloadCMake-a02d792c6e9bf9200ab652db6b6da415d80b578c.zip
CMake-a02d792c6e9bf9200ab652db6b6da415d80b578c.tar.gz
CMake-a02d792c6e9bf9200ab652db6b6da415d80b578c.tar.bz2
cxxmodules: add properties to control scanning
The `CXX_SCAN_FOR_MODULES` property may be used to control scanning for targets and for source files rather than assuming "C++20 always needs to be scanned".
Diffstat (limited to 'Help/prop_sf')
-rw-r--r--Help/prop_sf/CXX_SCAN_FOR_MODULES.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/Help/prop_sf/CXX_SCAN_FOR_MODULES.rst b/Help/prop_sf/CXX_SCAN_FOR_MODULES.rst
new file mode 100644
index 0000000..9d6c0a5
--- /dev/null
+++ b/Help/prop_sf/CXX_SCAN_FOR_MODULES.rst
@@ -0,0 +1,19 @@
+CXX_SCAN_FOR_MODULES
+--------------------
+
+.. versionadded:: 3.26
+
+``CXX_SCAN_FOR_MODULES`` is a boolean specifying whether CMake will scan the
+source for C++ module dependencies. See also the
+:prop_tgt:`CXX_SCAN_FOR_MODULES` for target-wide settings.
+
+When this property is set ``ON``, CMake will scan the source at build time and
+add module dependency information to the compile line as necessary. When this
+property is set ``OFF``, CMake will not scan the source at build time. When
+this property is unset, the :prop_tgt:`CXX_SCAN_FOR_MODULES` property is
+consulted.
+
+Note that scanning is only performed if C++20 or higher is enabled for the
+target and the source uses the ``CXX`` language. Scanning for modules in
+sources belonging to file sets of type ``CXX_MODULES`` and
+``CXX_MODULES_HEADER_UNITS`` is always performed.