diff options
author | Craig Scott <craig.scott@crascit.com> | 2023-02-25 06:15:17 (GMT) |
---|---|---|
committer | Craig Scott <craig.scott@crascit.com> | 2023-02-25 06:15:17 (GMT) |
commit | 9f1360ae19cc0194f19712583c3c5cf2703a4193 (patch) | |
tree | c9bf887494c632866ba7e8e62e8b3f44cc75a68d /Help/policy | |
parent | 030c70f92a13eb1420013d03e6fe1a82313f26d0 (diff) | |
download | CMake-9f1360ae19cc0194f19712583c3c5cf2703a4193.zip CMake-9f1360ae19cc0194f19712583c3c5cf2703a4193.tar.gz CMake-9f1360ae19cc0194f19712583c3c5cf2703a4193.tar.bz2 |
Help: Improve wording of FOLDER-related properties and policies
Diffstat (limited to 'Help/policy')
-rw-r--r-- | Help/policy/CMP0143.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Help/policy/CMP0143.rst b/Help/policy/CMP0143.rst index 7a7aee7..24fdc27 100644 --- a/Help/policy/CMP0143.rst +++ b/Help/policy/CMP0143.rst @@ -5,7 +5,7 @@ CMP0143 :prop_gbl:`USE_FOLDERS` global property is treated as ``ON`` by default. -When using CMake 3.25 and below, :prop_gbl:`USE_FOLDERS` is treated +When using CMake 3.25 or earlier, :prop_gbl:`USE_FOLDERS` is treated as ``OFF`` by default unless projects enable the feature. For example: .. code-block:: cmake @@ -16,15 +16,15 @@ as ``OFF`` by default unless projects enable the feature. For example: CMake 3.26 and later prefer to enable the feature by default. +Note that it is the policy setting at the `end` of the top level +``CMakeLists.txt`` file that matters. The policy setting applies globally +to the whole project. + This policy provides compatibility with projects that have not been updated to expect enabling of folders. Enabling folders causes projects to appear -differently in IDEs. - -This policy was introduced in CMake version 3.26. Use the +differently in IDEs. The policy was introduced in CMake version 3.26. Use the :command:`cmake_policy` command to set it to ``OLD`` or ``NEW`` explicitly. Unlike many policies, CMake version |release| does *not* warn when this policy is not set and simply uses ``OLD`` behavior. -The policy setting must be in scope at the end of the top-level -``CMakeLists.txt`` file of the project and has global effect. .. include:: DEPRECATED.txt |