https://github.com/Kitware/CMake
Tip revision: 67a1e2a5d17aec461ed464fa254fb01f32a0a384 authored by Brad King on 22 February 2023, 15:06:26 UTC
CMake 3.26.0-rc4
CMake 3.26.0-rc4
Tip revision: 67a1e2a
CheckCompilerFlag.cmake
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.
#[=======================================================================[.rst:
CheckCompilerFlag
---------------------
.. versionadded:: 3.19
Check whether the compiler supports a given flag.
.. command:: check_compiler_flag
.. code-block:: cmake
check_compiler_flag(<lang> <flag> <var>)
Check that the ``<flag>`` is accepted by the compiler without a diagnostic.
Stores the result in an internal cache entry named ``<var>``.
This command temporarily sets the ``CMAKE_REQUIRED_DEFINITIONS`` variable
and calls the ``check_source_compiles(<LANG>)`` function from the
:module:`CheckSourceCompiles` module. See documentation of that
module for a listing of variables that can otherwise modify the build.
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.
.. note::
Since the :command:`try_compile` command forwards flags from variables
like :variable:`CMAKE_<LANG>_FLAGS <CMAKE_<LANG>_FLAGS>`, unknown flags
in such variables may cause a false negative for this check.
#]=======================================================================]
include_guard(GLOBAL)
include(Internal/CheckCompilerFlag)
function(CHECK_COMPILER_FLAG _lang _flag _var)
cmake_check_compiler_flag(${_lang} "${_flag}" ${_var})
endfunction()