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/prop_gbl | |
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/prop_gbl')
-rw-r--r-- | Help/prop_gbl/USE_FOLDERS.rst | 18 |
1 files changed, 8 insertions, 10 deletions
diff --git a/Help/prop_gbl/USE_FOLDERS.rst b/Help/prop_gbl/USE_FOLDERS.rst index f3d7791..6f5a083 100644 --- a/Help/prop_gbl/USE_FOLDERS.rst +++ b/Help/prop_gbl/USE_FOLDERS.rst @@ -1,19 +1,17 @@ USE_FOLDERS ----------- -Use the :prop_tgt:`FOLDER` target property to organize targets into -folders. +Controls whether to use the :prop_tgt:`FOLDER` target property to organize +targets into folders. The value of ``USE_FOLDERS`` at the end of the top level +``CMakeLists.txt`` file is what determines the behavior. .. versionchanged:: 3.26 CMake treats this property as ``ON`` by default. See policy :policy:`CMP0143`. -CMake generators that are capable of organizing into a hierarchy of folders -use the values of the :prop_tgt:`FOLDER` target property to name those -folders. (i.e.: ``Visual Studio`` or ``XCode``) - -IDE's can also take advantage of this property to organize CMake targets. -Regardless of generator support. - -See also the documentation for the :prop_tgt:`FOLDER` target property. +Not all CMake generators support recording folder details for targets. +The :generator:`Xcode` and :ref:`Visual Studio <Visual Studio Generators>` +generators are examples of generators that do. Similarly, not all IDEs +support presenting targets using folder hierarchies, even if the CMake +generator used provides the necessary information. |