Kitware/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-19 02:17:27 +08:00
Code Issues Projects Releases Wiki Activity

GENERATED: Improve the documentation of the GENERATED file property

Browse Source
This commit is contained in:
Robert Maynard
2018-01-03 09:38:20 -05:00
parent 1f29bc4092
commit 11615b297f
1 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
Help/prop_sf/GENERATED.rst
View File

@@ -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.