CMake/Help/command/utility_source.rst
Michael Scott c3f40f4fd9 Help: Improve formatting of command documentation
Use inline reStructuredText markup and add cross-references in more
places.
2015-06-08 16:28:31 -04:00

25 lines
940 B
ReStructuredText

utility_source
--------------
Disallowed. See CMake Policy :policy:`CMP0034`.
Specify the source tree of a third-party utility.
::
utility_source(cache_entry executable_name
path_to_source [file1 file2 ...])
When a third-party utility's source is included in the distribution,
this command specifies its location and name. The cache entry will
not be set unless the ``path_to_source`` and all listed files exist. It
is assumed that the source tree of the utility will have been built
before it is needed.
When cross compiling CMake will print a warning if a ``utility_source()``
command is executed, because in many cases it is used to build an
executable which is executed later on. This doesn't work when cross
compiling, since the executable can run only on their target platform.
So in this case the cache entry has to be adjusted manually so it
points to an executable which is runnable on the build host.