summaryrefslogtreecommitdiffstats
path: root/Help/policy
diff options
context:
space:
mode:
authorJuan Ramos <cmake@jpr.mozmail.com>2022-11-06 22:52:42 (GMT)
committerBrad King <brad.king@kitware.com>2022-11-08 14:32:18 (GMT)
commitd3acd22380663bd4061abf07384d507c589d3286 (patch)
treed56d36f61646b251a909a2feba9f6954b8e6f3f6 /Help/policy
parent3ee1017ce66d86190460d5c842324ea2a4870ae3 (diff)
downloadCMake-d3acd22380663bd4061abf07384d507c589d3286.zip
CMake-d3acd22380663bd4061abf07384d507c589d3286.tar.gz
CMake-d3acd22380663bd4061abf07384d507c589d3286.tar.bz2
USE_FOLDERS: Treat as on by default
Add a policy to treat the `USE_FOLDERS` global property as ON by default if it is not set. Fixes: #21695
Diffstat (limited to 'Help/policy')
-rw-r--r--Help/policy/CMP0143.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/Help/policy/CMP0143.rst b/Help/policy/CMP0143.rst
new file mode 100644
index 0000000..7a7aee7
--- /dev/null
+++ b/Help/policy/CMP0143.rst
@@ -0,0 +1,30 @@
+CMP0143
+-------
+
+.. versionadded:: 3.26
+
+: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
+as ``OFF`` by default unless projects enable the feature. For example:
+
+.. code-block:: cmake
+
+ cmake_minimum_required(VERSION 3.25)
+ project(foobar LANGUAGES CXX)
+ set_property(GLOBAL PROPERTY USE_FOLDERS ON)
+
+CMake 3.26 and later prefer to enable the feature by default.
+
+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
+: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