CMake/Help/policy/CMP0024.rst

CMP0024
-------

Disallow include export result.

CMake 2.8.12 and lower allowed use of the include() command with the
result of the export() command.  This relies on the assumption that
the export() command has an immediate effect at configure-time during
a cmake run.  Certain properties of targets are not fully determined
until later at generate-time, such as the link language and complete
list of link libraries.  Future refactoring will change the effect of
the export() command to be executed at generate-time.  Use ALIAS
targets instead in cases where the goal is to refer to targets by
another name.

The OLD behavior for this policy is to allow including the result of
an export() command.  The NEW behavior for this policy is not to
allow including the result of an export() command.

This policy was introduced in CMake version 3.0.  CMake version
|release| warns when the policy is not set and uses OLD behavior.  Use
the cmake_policy command to set it to OLD or NEW explicitly.

.. include:: DEPRECATED.txt
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it. 2013-10-15 15:17:36 +00:00			`CMP0024`
			`-------`

			`Disallow include export result.`

			`CMake 2.8.12 and lower allowed use of the include() command with the`
			`result of the export() command. This relies on the assumption that`
			`the export() command has an immediate effect at configure-time during`
			`a cmake run. Certain properties of targets are not fully determined`
			`until later at generate-time, such as the link language and complete`
			`list of link libraries. Future refactoring will change the effect of`
			`the export() command to be executed at generate-time. Use ALIAS`
			`targets instead in cases where the goal is to refer to targets by`
Help: Add missing period. 2013-12-14 14:40:29 +00:00			`another name.`
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it. 2013-10-15 15:17:36 +00:00
			`The OLD behavior for this policy is to allow including the result of`
Help: Fix typo. 'to not to' -> 'not to' 2014-02-06 10:54:34 +00:00			`an export() command. The NEW behavior for this policy is not to`
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it. 2013-10-15 15:17:36 +00:00			`allow including the result of an export() command.`

Help: Change version 3.0.0 -> 3.0 in policy docs Starting with 3.0 we will use only two components for the feature level, and policies are only ever introduced with a bump to the feature level version. 2014-02-10 16:40:21 +00:00			`This policy was introduced in CMake version 3.0. CMake version`
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it. 2013-10-15 15:17:36 +00:00			`\|release\| warns when the policy is not set and uses OLD behavior. Use`
			`the cmake_policy command to set it to OLD or NEW explicitly.`
Help: Document explicitly that policy OLD behavior is deprecated The most likely documentation page a project author will read in response to a policy warning is the page for the policy itself. Add to every policy documentation page a note explicitly stating that the OLD behavior is deprecated. Also mention this in the cmake_policy() command documentation that explains how to set a policy to OLD. Suggested-by: Fraser Hutchison <fraser.hutchison@gmail.com> 2015-06-09 13:29:41 +00:00
			`.. include:: DEPRECATED.txt`