mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-05-05 13:50:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Help: check_*source_compiles and CMAKE_TRY_COMPILE_TARGET_TYPE

Browse Source 
Ref: #26103
This commit is contained in:
scivision
2024-07-04 16:34:42 -04:00
committed by Brad King
parent 9c330283d6
commit 4b9ed91424
6 changed files with 101 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Modules/CheckCXXSourceCompiles.cmake
+14 -12
View File
@@ -5,7 +5,7 @@
CheckCXXSourceCompiles
----------------------
Check if given C++ source compiles and links into an executable.
Check once if C++ source code can be built.
.. command:: check_cxx_source_compiles
@@ -14,19 +14,21 @@ Check if given C++ source compiles and links into an executable.
check_cxx_source_compiles(<code> <resultVar>
[FAIL_REGEX <regex1> [<regex2>...]])
Check that the source supplied in ``<code>`` can be compiled as a C++ source
file and linked as an executable (so it must contain at least a ``main()``
function). The result will be stored in the internal cache variable specified
by ``<resultVar>``, with a boolean true value for success and boolean false
for failure. If ``FAIL_REGEX`` is provided, then failure is determined by
checking if anything in the output matches any of the specified regular
Check once that the source supplied in ``<code>`` can be built. The result is
stored in the internal cache variable specified by ``<resultVar>``, with
boolean ``true`` for success and boolean ``false`` for failure.
If ``FAIL_REGEX`` is provided, then failure is determined by checking
if anything in the compiler output matches any of the specified regular
expressions.
The check is only performed once, with the result cached in the variable named
by ``<resultVar>``. Every subsequent CMake run will reuse this cached value
rather than performing the check again, even if the ``<code>`` changes. In
order to force the check to be re-evaluated, the variable named by
``<resultVar>`` must be manually removed from the cache.
Internally, :command:`try_compile` is used to compile the source. If
:variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` is set to ``EXECUTABLE`` (default),
the source is compiled and linked as an executable program. If set to
``STATIC_LIBRARY``, the source is compiled but not linked. In any case, all
functions must be declared as usual.
See also :command:`check_source_runs` to run compiled source.
The compile and link commands can be influenced by setting any of the
following variables prior to calling ``check_cxx_source_compiles()``: