summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBartosz Kosiorek <gang65@poczta.onet.pl>2016-01-28 10:52:15 +0100
committerBrad King <brad.king@kitware.com>2016-01-28 10:13:18 -0500
commit8c615af4dfaaec38dfb7f42ec951485644c2e24b (patch)
treef4e68c4180d422ad4cc034164bbda2f1691bdcca
parent63c5808f9328797ef225c0d81d60b0fa39ac7d3b (diff)
downloadcmake-8c615af4dfaaec38dfb7f42ec951485644c2e24b.tar.gz
Help: Clarify policy `CMP0040` documentation (#15681)
State explicitly that the target must be defined in the current directory. While at it, improve markup formatting.
-rw-r--r--Help/policy/CMP0040.rst19
1 files changed, 11 insertions, 8 deletions
diff --git a/Help/policy/CMP0040.rst b/Help/policy/CMP0040.rst
index e746c03165..d46baf647b 100644
--- a/Help/policy/CMP0040.rst
+++ b/Help/policy/CMP0040.rst
@@ -1,18 +1,21 @@
CMP0040
-------
-The target in the TARGET signature of add_custom_command() must exist.
+The target in the ``TARGET`` signature of :command:`add_custom_command`
+must exist and must be defined in current directory.
CMake 2.8.12 and lower silently ignored a custom command created with
-the TARGET signature of :command:`add_custom_command`
-if the target is unknown.
+the ``TARGET`` signature of :command:`add_custom_command`
+if the target is unknown or was defined outside the current directory.
-The OLD behavior for this policy is to ignore custom commands
-for unknown targets. The NEW behavior for this policy is to report an error
-if the target referenced in :command:`add_custom_command` is unknown.
+The ``OLD`` behavior for this policy is to ignore custom commands
+for unknown targets. The ``NEW`` behavior for this policy is to report
+an error if the target referenced in :command:`add_custom_command` is
+unknown or was defined outside the current directory.
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.
+|release| warns when the policy is not set and uses ``OLD`` behavior.
+Use the :command:`cmake_policy` command to set it to ``OLD`` or
+``NEW`` explicitly.
.. include:: DEPRECATED.txt