cmake/Help/prop_tgt/LOCATION.rst

29 lines
1.3 KiB
ReStructuredText
Raw Normal View History

2014-08-03 19:52:23 +02:00
LOCATION
--------
Read-only location of a target on disk.
For an imported target, this read-only property returns the value of
2019-11-11 23:01:05 +01:00
the ``LOCATION_<CONFIG>`` property for an unspecified configuration
``<CONFIG>`` provided by the target.
2014-08-03 19:52:23 +02:00
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
2019-11-11 23:01:05 +01:00
executable target's output file for use in :command:`add_custom_command`. The
2014-08-03 19:52:23 +02:00
path may contain a build-system-specific portion that is replaced at
build time with the configuration getting built (such as
2019-11-11 23:01:05 +01:00
``$(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.
2014-08-03 19:52:23 +02:00
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
2019-11-11 23:01:05 +01:00
``(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?``,
2014-08-03 19:52:23 +02:00
``(IMPLIB_)?(PREFIX|SUFFIX)``, or "LINKER_LANGUAGE". Failure to follow
this rule is not diagnosed and leaves the location of the target
undefined.