5d42177a06
The CheckSourceCompiles and CheckCompilerFlag would generally be preferred general command syntax, but users may not realize they exist, so help point them there.
42 lines
1.5 KiB
CMake
42 lines
1.5 KiB
CMake
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
# file Copyright.txt or https://cmake.org/licensing for details.
|
|
|
|
#[=======================================================================[.rst:
|
|
CheckCXXCompilerFlag
|
|
------------------------
|
|
|
|
Check whether the CXX compiler supports a given flag.
|
|
|
|
.. command:: check_cxx_compiler_flag
|
|
|
|
.. code-block:: cmake
|
|
|
|
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.
|
|
|
|
See also :command:`check_compiler_flag` for a more general command syntax.
|
|
|
|
.. 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.
|
|
#]=======================================================================]
|
|
|
|
include_guard(GLOBAL)
|
|
include(Internal/CheckCompilerFlag)
|
|
|
|
macro (CHECK_CXX_COMPILER_FLAG _FLAG _RESULT)
|
|
cmake_check_compiler_flag(CXX "${_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(CheckCXXSourceCompiles)
|