diff options
| author | Deniz Bahadir <deniz@code.bahadir.email> | 2024-03-19 23:42:16 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2024-03-21 15:37:46 (GMT) |
| commit | 1dabbbb5e0961edf453f939daec16d156f0666f9 (patch) | |
| tree | 8ef37fc21e02244c0bbb7fde3b46f0fc4e73317a /Help/prop_sf | |
| parent | d2f5b79795883f5ba77a3feab4feff977a666aa7 (diff) | |
| download | CMake-1dabbbb5e0961edf453f939daec16d156f0666f9.zip CMake-1dabbbb5e0961edf453f939daec16d156f0666f9.tar.gz CMake-1dabbbb5e0961edf453f939daec16d156f0666f9.tar.bz2 | |
CMP0118: Revise documentation to describe actual behavior
The policy was originally intended to make the `GENERATED` source file
property globally visible, but the implementation didn't fully achieve
that goal. Revise the documentation to describe what it actually does.
Issue: #25437
Diffstat (limited to 'Help/prop_sf')
| -rw-r--r-- | Help/prop_sf/GENERATED.rst | 14 |
1 files changed, 5 insertions, 9 deletions
diff --git a/Help/prop_sf/GENERATED.rst b/Help/prop_sf/GENERATED.rst index 5ecc86c..d68ae4b 100644 --- a/Help/prop_sf/GENERATED.rst +++ b/Help/prop_sf/GENERATED.rst @@ -4,7 +4,11 @@ GENERATED Is this source file generated as part of the build or CMake process. .. versionchanged:: 3.20 - The GENERATED source file property is now visible in all directories. + Turning on the ``GENERATED`` source file property in one directory allows + the associated source file to be used across directories without the need + to manually setting that property for other directory scopes, too. + Additionally, it may now be set only to boolean values, and may not be + turned off once turned on. See policy :policy:`CMP0118`. 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. @@ -38,11 +42,3 @@ be shown. For the special case of sources generated by CMake's :prop_tgt:`AUTOMO :prop_gbl:`AUTORCC_SOURCE_GROUP` and :prop_gbl:`AUTOUIC_SOURCE_GROUP` target properties may influence where the generated sources are grouped in the project's file lists. - -.. note:: - - Starting with CMake 3.20 the ``GENERATED`` source file property can be set - and retrieved from any directory scope. It is an all-or-nothing property. - It also can no longer be removed or unset if it was set to ``TRUE``. Policy - :policy:`CMP0118` was introduced to allow supporting the ``OLD`` behavior - for some time. |