diff options
author | Brad King <brad.king@kitware.com> | 2021-03-18 14:00:02 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2021-03-18 14:00:02 (GMT) |
commit | 17eb610a314a3100146e478d72fd0e6f1d0a058f (patch) | |
tree | 4ed28f90f92c4d322a390e01d7e6ae3335aa858b /Help/policy/CMP0118.rst | |
parent | 06feb845aab7127a3067567a8fffb5777eac8187 (diff) | |
download | CMake-17eb610a314a3100146e478d72fd0e6f1d0a058f.zip CMake-17eb610a314a3100146e478d72fd0e6f1d0a058f.tar.gz CMake-17eb610a314a3100146e478d72fd0e6f1d0a058f.tar.bz2 |
Help: Document CMP0118 requirement for boolean values
Diffstat (limited to 'Help/policy/CMP0118.rst')
-rw-r--r-- | Help/policy/CMP0118.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/Help/policy/CMP0118.rst b/Help/policy/CMP0118.rst index b43a766..aa7e0f7 100644 --- a/Help/policy/CMP0118.rst +++ b/Help/policy/CMP0118.rst @@ -10,10 +10,16 @@ property of the source. Consequently, the associated ``GENERATED`` property is now visible from any directory scope, not only from the scope for which it was set. +Additionally, the ``GENERATED`` property may now be set only to boolean +values, and may not be turned off once turned on. + The ``OLD`` behavior of this policy is to only allow ``GENERATED`` to be visible from the directory scope for which it was set. The ``NEW`` behavior on the other hand allows it to be visible from any scope. -This policy was introduced in CMake version 3.20. CMake version |release| -warns when the policy is not set and uses ``OLD`` behavior. Use the +This policy was introduced in CMake version 3.20. Use the :command:`cmake_policy` command to set it to ``OLD`` or ``NEW`` explicitly. +Unlike many policies, CMake version |release| does *not* warn +when this policy is not set and simply uses ``OLD`` behavior with regard +to visibility of the ``GENERATED`` property. However, CMake does warn +about setting the ``GENERATED`` property to a non-boolean value. |