diff options
| author | Craig Scott <craig.scott@crascit.com> | 2018-01-09 10:05:32 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2018-01-09 10:05:41 (GMT) |
| commit | 89d12746306571a323549ad0f8d11284999053d5 (patch) | |
| tree | 68aa8bc884ff493ec99d224fe1c6ff7b6971c482 /Help | |
| parent | b9bada655ec1a68d65a2536f300c9d6f9cd7aabc (diff) | |
| parent | 11615b297fcb34fe1e51f74a66e72cc70efdf703 (diff) | |
| download | CMake-89d12746306571a323549ad0f8d11284999053d5.zip CMake-89d12746306571a323549ad0f8d11284999053d5.tar.gz CMake-89d12746306571a323549ad0f8d11284999053d5.tar.bz2 | |
Merge topic 'improve_generated_property_docs'
11615b29 GENERATED: Improve the documentation of the GENERATED file property
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !1630
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/prop_sf/GENERATED.rst | 23 |
1 files changed, 19 insertions, 4 deletions
diff --git a/Help/prop_sf/GENERATED.rst b/Help/prop_sf/GENERATED.rst index a3aa127..d430ee2 100644 --- a/Help/prop_sf/GENERATED.rst +++ b/Help/prop_sf/GENERATED.rst @@ -1,8 +1,23 @@ GENERATED --------- -Is this source file generated as part of the build process. +Is this source file generated as part of the build or CMake process. -If a source file is generated by the build process CMake will handle -it differently in terms of dependency checking etc. Otherwise having -a non-existent source file could create problems. +Tells the internal CMake engine that a source file is generated by an outside +process such as another build step, or the execution of CMake itself. This +information is then used to exempt the file from any existence or validity +checks. Generated files are created by the execution of commands such as +:command:`add_custom_command` and :command:`file(GENERATE)`. + +When a generated file created by an :command:`add_custom_command` command +is explicitly listed as a source file for any target in the same +directory scope (which usually means the same ``CMakeLists.txt`` file), +CMake will automatically create a dependency to make sure the file is +generated before building that target. + +Generated sources may be hidden in some IDE tools, while in others they might +be shown. For the special case of sources generated by CMake's :prop_tgt:`AUTOMOC` +or :prop_tgt:`AUTORCC` functionality, the :prop_gbl:`AUTOGEN_SOURCE_GROUP`, +:prop_gbl:`AUTOMOC_SOURCE_GROUP` and :prop_gbl:`AUTORCC_SOURCE_GROUP` target +properties may influence where the generated sources are grouped in the project's +file lists. |