Autogen: Doc: Update CMP0071 description

This commit is contained in:
Sebastian Holtermann 2017-09-26 17:46:33 +02:00
parent b0775c751b
commit 8831818f14

View File

@ -4,16 +4,15 @@ CMP0071
Let :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` process
:prop_sf:`GENERATED` files.
CMake 3.10 and newer process regular *and* :prop_sf:`GENERATED` source files
in :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`.
In CMake 3.9 and lower, only regular source files were processed in
:prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`,
:prop_sf:`GENERATED` source files were ignored.
Since version 3.10, CMake processes **regular** and :prop_sf:`GENERATED`
source files in :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`.
In earlier CMake versions, only **regular** source files were processed.
:prop_sf:`GENERATED` source files were ignored silently.
This policy affects how :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` process
source files that are :prop_sf:`GENERATED`.
This policy affects how source files that are :prop_sf:`GENERATED`
get treated in :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`.
The ``OLD`` behavior for this policy is to *ignore* :prop_sf:`GENERATED`
The ``OLD`` behavior for this policy is to ignore :prop_sf:`GENERATED`
source files in :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`.
The ``NEW`` behavior for this policy is to process :prop_sf:`GENERATED`
@ -21,10 +20,19 @@ source files in :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` just like regular
source files.
.. note::
To exclude source files from :prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC`
processing, the boolean source file properties
:prop_sf:`SKIP_AUTOMOC`, :prop_sf:`SKIP_AUTOUIC` and :prop_sf:`SKIP_AUTOGEN`
can be set accordingly.
To silence the CMP0071 warning source files can be excluded from
:prop_tgt:`AUTOMOC` and :prop_tgt:`AUTOUIC` processing by setting the
source file properties :prop_sf:`SKIP_AUTOMOC`, :prop_sf:`SKIP_AUTOUIC` or
:prop_sf:`SKIP_AUTOGEN`.
Source skip example::
# ...
set_property(SOURCE /path/to/file1.h PROPERTY SKIP_AUTOMOC ON)
set_property(SOURCE /path/to/file2.h PROPERTY SKIP_AUTOUIC ON)
set_property(SOURCE /path/to/file3.h PROPERTY SKIP_AUTOGEN ON)
# ...
This policy was introduced in CMake version 3.10. CMake version
|release| warns when the policy is not set and uses ``OLD`` behavior.