diff options
| author | Brad King <brad.king@kitware.com> | 2023-02-01 13:23:56 -0500 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2023-02-01 13:58:23 -0500 |
| commit | bc1ba6d56b1297cc4677e527bfbe85f3502eb13e (patch) | |
| tree | 77b287eeff9036b85d5c052e10f8c59fecc99bcf | |
| parent | 71f9c1943d63805cf3a87fcb832a7c664e8d1a47 (diff) | |
| download | cmake-bc1ba6d56b1297cc4677e527bfbe85f3502eb13e.tar.gz | |
Help: Document experimental feature gate affecting CXX_SCAN_FOR_MODULES
Also drop the release note for `CXX_SCAN_FOR_MODULES`, as the rest of
the C++ modules support has not yet been mentioned in release notes
(since it is still experimental).
| -rw-r--r-- | Help/prop_sf/CXX_SCAN_FOR_MODULES.rst | 5 | ||||
| -rw-r--r-- | Help/prop_tgt/CXX_SCAN_FOR_MODULES.rst | 5 | ||||
| -rw-r--r-- | Help/release/dev/cxx-scanning-properties.rst | 5 | ||||
| -rw-r--r-- | Help/variable/CMAKE_CXX_SCAN_FOR_MODULES.rst | 5 |
4 files changed, 15 insertions, 5 deletions
diff --git a/Help/prop_sf/CXX_SCAN_FOR_MODULES.rst b/Help/prop_sf/CXX_SCAN_FOR_MODULES.rst index 9d6c0a57af..23c48597d3 100644 --- a/Help/prop_sf/CXX_SCAN_FOR_MODULES.rst +++ b/Help/prop_sf/CXX_SCAN_FOR_MODULES.rst @@ -17,3 +17,8 @@ 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. + +.. note :: + + This setting is meaningful only when experimental support for C++ modules + has been enabled by the ``CMAKE_EXPERIMENTAL_CXX_MODULE_CMAKE_API`` gate. diff --git a/Help/prop_tgt/CXX_SCAN_FOR_MODULES.rst b/Help/prop_tgt/CXX_SCAN_FOR_MODULES.rst index 5e89ba2996..e2127c2843 100644 --- a/Help/prop_tgt/CXX_SCAN_FOR_MODULES.rst +++ b/Help/prop_tgt/CXX_SCAN_FOR_MODULES.rst @@ -20,3 +20,8 @@ scan the target's ``CXX`` sources at build time. Note that scanning is only performed if C++20 or higher is enabled for the target. Scanning for modules in the target's sources belonging to file sets of type ``CXX_MODULES`` and ``CXX_MODULES_HEADER_UNITS`` is always performed. + +.. note :: + + This setting is meaningful only when experimental support for C++ modules + has been enabled by the ``CMAKE_EXPERIMENTAL_CXX_MODULE_CMAKE_API`` gate. diff --git a/Help/release/dev/cxx-scanning-properties.rst b/Help/release/dev/cxx-scanning-properties.rst deleted file mode 100644 index b393728800..0000000000 --- a/Help/release/dev/cxx-scanning-properties.rst +++ /dev/null @@ -1,5 +0,0 @@ -cxx-scanning-properties ------------------------ - -* The :prop_tgt:`CXX_SCAN_FOR_MODULES` target and source file properties may - be used to enable or disable scanning for C++ module dependencies. diff --git a/Help/variable/CMAKE_CXX_SCAN_FOR_MODULES.rst b/Help/variable/CMAKE_CXX_SCAN_FOR_MODULES.rst index 0d6c636800..a40bf7524a 100644 --- a/Help/variable/CMAKE_CXX_SCAN_FOR_MODULES.rst +++ b/Help/variable/CMAKE_CXX_SCAN_FOR_MODULES.rst @@ -8,3 +8,8 @@ Whether to scan C++ source files for module dependencies. This variable is used to initialize the :prop_tgt:`CXX_SCAN_FOR_MODULES` property on all the targets. See that target property for additional information. + +.. note :: + + This setting is meaningful only when experimental support for C++ modules + has been enabled by the ``CMAKE_EXPERIMENTAL_CXX_MODULE_CMAKE_API`` gate. |