diff options
| author | Brad King <brad.king@kitware.com> | 2023-02-28 13:07:41 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2023-02-28 13:07:59 (GMT) |
| commit | 4902970328c9262ea649fa34663b684679d3ab97 (patch) | |
| tree | 1fa2318424e2330e07063b06be7d7aafb68f272f /Help/prop_tgt | |
| parent | e4b56c8224a95004dc53cbbec5fa7fa13590a329 (diff) | |
| parent | b39b3e3bdbcb363695d07a9bbd9e55182ed25318 (diff) | |
| download | CMake-4902970328c9262ea649fa34663b684679d3ab97.zip CMake-4902970328c9262ea649fa34663b684679d3ab97.tar.gz CMake-4902970328c9262ea649fa34663b684679d3ab97.tar.bz2 | |
Merge topic 'doc-cleanup-3.26-rc4'
b39b3e3bdb Help: Fix typos and grammar in 3.26 release notes
9f1360ae19 Help: Improve wording of FOLDER-related properties and policies
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8264
Diffstat (limited to 'Help/prop_tgt')
| -rw-r--r-- | Help/prop_tgt/FOLDER.rst | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/Help/prop_tgt/FOLDER.rst b/Help/prop_tgt/FOLDER.rst index 3155d90..616b962 100644 --- a/Help/prop_tgt/FOLDER.rst +++ b/Help/prop_tgt/FOLDER.rst @@ -1,16 +1,20 @@ FOLDER ------ -Set the folder name. Use to organize targets in an IDE. +For IDEs that present targets using a folder hierarchy, this property +specifies the name of the folder to place the target under. +To nest folders, use ``FOLDER`` values such as ``GUI/Dialogs`` with ``/`` +characters separating folder levels. Targets with no ``FOLDER`` property +will appear as top level entities. Targets with the same ``FOLDER`` +property value will appear in the same folder as siblings. -Targets with no ``FOLDER`` property will appear as top level entities in -IDEs like Visual Studio. Targets with the same ``FOLDER`` property value -will appear next to each other in a folder of that name. To nest -folders, use ``FOLDER`` values such as 'GUI/Dialogs' with '/' characters -separating folder levels. +Only some CMake generators honor the ``FOLDER`` property +(e.g. :generator:`Xcode` or any of the +:ref:`Visual Studio <Visual Studio Generators>` generators). +Those generators that don't will simply ignore it. This property is initialized by the value of the variable :variable:`CMAKE_FOLDER` if it is set when a target is created. -The global property :prop_gbl:`USE_FOLDERS` must be set to ON, otherwise +The global property :prop_gbl:`USE_FOLDERS` must be set to true, otherwise the ``FOLDER`` property is ignored. |