mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-03 20:29:56 -06:00
5d42177a06
The CheckSourceCompiles and CheckCompilerFlag would generally be preferred general command syntax, but users may not realize they exist, so help point them there.
59 lines
2.0 KiB
CMake
59 lines
2.0 KiB
CMake
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
# file Copyright.txt or https://cmake.org/licensing for details.
|
|
|
|
#[=======================================================================[.rst:
|
|
CheckCCompilerFlag
|
|
------------------
|
|
|
|
Check whether the C compiler supports a given flag.
|
|
|
|
.. command:: check_c_compiler_flag
|
|
|
|
.. code-block:: cmake
|
|
|
|
check_c_compiler_flag(<flag> <resultVar>)
|
|
|
|
Check that the ``<flag>`` is accepted by the compiler without
|
|
a diagnostic. Stores the result in an internal cache entry
|
|
named ``<resultVar>``.
|
|
|
|
A positive result from this check indicates only that the compiler did not
|
|
issue a diagnostic message when given the flag. Whether the flag has any
|
|
effect or even a specific one is beyond the scope of this module.
|
|
|
|
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.
|
|
|
|
See also :command:`check_compiler_flag` for a more general command syntax.
|
|
|
|
The compile and link commands can be influenced by setting any of the
|
|
following variables prior to calling ``check_c_compiler_flag()``
|
|
|
|
.. include:: /module/CMAKE_REQUIRED_FLAGS.txt
|
|
|
|
.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt
|
|
|
|
.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt
|
|
|
|
.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt
|
|
|
|
.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt
|
|
|
|
.. include:: /module/CMAKE_REQUIRED_QUIET.txt
|
|
|
|
#]=======================================================================]
|
|
|
|
include_guard(GLOBAL)
|
|
include(Internal/CheckCompilerFlag)
|
|
|
|
macro (CHECK_C_COMPILER_FLAG _FLAG _RESULT)
|
|
cmake_check_compiler_flag(C "${_FLAG}" ${_RESULT})
|
|
endmacro ()
|
|
|
|
# FIXME(#24994): The following module is included only for compatibility
|
|
# with projects that accidentally relied on it with CMake 3.26 and below.
|
|
include(CheckCSourceCompiles)
|