cmake/Modules/CheckCXXCompilerFlag.cmake

40 lines
1.4 KiB
CMake
Raw Normal View History

2016-10-30 18:24:19 +01:00
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
# file Copyright.txt or https://cmake.org/licensing for details.
2018-01-26 17:06:56 +01:00
#[=======================================================================[.rst:
CheckCXXCompilerFlag
------------------------
Check whether the CXX compiler supports a given flag.
.. command:: check_cxx_compiler_flag
2019-11-11 23:01:05 +01:00
.. code-block:: cmake
2018-01-26 17:06:56 +01:00
check_cxx_compiler_flag(<flag> <var>)
Check that the ``<flag>`` is accepted by the compiler without
a diagnostic. Stores the result in an internal cache entry
named ``<var>``.
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_CXX_FLAGS <CMAKE_<LANG>_FLAGS>`, unknown flags
in such variables may cause a false negative for this check.
#]=======================================================================]
2018-04-23 21:13:27 +02:00
include_guard(GLOBAL)
2021-09-14 00:13:48 +02:00
include(Internal/CheckCompilerFlag)
macro (CHECK_CXX_COMPILER_FLAG _FLAG _RESULT)
cmake_check_compiler_flag(CXX "${_FLAG}" ${_RESULT})
endmacro ()
2023-07-02 19:51:09 +02:00
# FIXME(#24994): The following module is included only for compatibility
# with projects that accidentally relied on it with CMake 3.26 and below.
include(CheckCXXSourceCompiles)