summaryrefslogtreecommitdiffstats
path: root/Help/prop_tgt/LOCATION.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-04-04 15:48:44 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-04-04 15:48:55 (GMT)
commit56abc31270cbe60845021107383f1cede0ed075e (patch)
tree07242ad4c4dae0ea7cf479aa1a219854ad9f4e07 /Help/prop_tgt/LOCATION.rst
parenta6324490e501154dba620a2495afd6f09eea8167 (diff)
parent456e0fb64f5c70191145c34104d6f25bd24b7b37 (diff)
downloadCMake-56abc31270cbe60845021107383f1cede0ed075e.zip
CMake-56abc31270cbe60845021107383f1cede0ed075e.tar.gz
CMake-56abc31270cbe60845021107383f1cede0ed075e.tar.bz2
Merge topic 'improve-documentation'
456e0fb64f Help: Improve documentation formating Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3174
Diffstat (limited to 'Help/prop_tgt/LOCATION.rst')
-rw-r--r--Help/prop_tgt/LOCATION.rst19
1 files changed, 10 insertions, 9 deletions
diff --git a/Help/prop_tgt/LOCATION.rst b/Help/prop_tgt/LOCATION.rst
index 16d5696..d058064 100644
--- a/Help/prop_tgt/LOCATION.rst
+++ b/Help/prop_tgt/LOCATION.rst
@@ -4,24 +4,25 @@ LOCATION
Read-only location of a target on disk.
For an imported target, this read-only property returns the value of
-the LOCATION_<CONFIG> property for an unspecified configuration
-<CONFIG> provided by the target.
+the ``LOCATION_<CONFIG>`` property for an unspecified configuration
+``<CONFIG>`` provided by the target.
For a non-imported target, this property is provided for compatibility
with CMake 2.4 and below. It was meant to get the location of an
-executable target's output file for use in add_custom_command. The
+executable target's output file for use in :command:`add_custom_command`. The
path may contain a build-system-specific portion that is replaced at
build time with the configuration getting built (such as
-"$(ConfigurationName)" in VS). In CMake 2.6 and above
-add_custom_command automatically recognizes a target name in its
-COMMAND and DEPENDS options and computes the target location. In
-CMake 2.8.4 and above add_custom_command recognizes generator
-expressions to refer to target locations anywhere in the command.
+``$(ConfigurationName)`` in VS). In CMake 2.6 and above
+:command:`add_custom_command` automatically recognizes a target name in its
+``COMMAND`` and ``DEPENDS`` options and computes the target location. In
+CMake 2.8.4 and above :command:`add_custom_command` recognizes
+:manual:`generator expressions <cmake-generator-expressions(7)>`
+to refer to target locations anywhere in the command.
Therefore this property is not needed for creating custom commands.
Do not set properties that affect the location of a target after
reading this property. These include properties whose names match
-"(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?",
+``(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?``,
``(IMPLIB_)?(PREFIX|SUFFIX)``, or "LINKER_LANGUAGE". Failure to follow
this rule is not diagnosed and leaves the location of the target
undefined.