mirror of
https://github.com/reactos/CMake.git
synced 2025-02-18 18:49:34 +00:00
Check*CompilerFlag: Rewrite documentation of these modules
Format with modern markup. Clarify that the setting of `CMAKE_REQUIRED_DEFINITIONS` is temporary. Add a note warning about contamination of the checks by `CMAKE_<LANG>_FLAGS`. Issue: #16973
This commit is contained in:
parent
7c5299add4
commit
aa944c88e3
@ -1,26 +1,36 @@
|
||||
# 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.
|
||||
#
|
||||
# CHECK_C_COMPILER_FLAG(<flag> <var>)
|
||||
#
|
||||
# ::
|
||||
#
|
||||
# <flag> - the compiler flag
|
||||
# <var> - variable to store the result
|
||||
# Will be created as an internal cache variable.
|
||||
#
|
||||
# This internally calls the check_c_source_compiles macro and sets
|
||||
# CMAKE_REQUIRED_DEFINITIONS to <flag>. See help for
|
||||
# CheckCSourceCompiles for a listing of variables that can otherwise
|
||||
# modify the build. The result only tells that the compiler does not
|
||||
# give an error message when it encounters the flag. If the flag has
|
||||
# any effect or even a specific one is beyond the scope of this module.
|
||||
#[=======================================================================[.rst:
|
||||
CheckCCompilerFlag
|
||||
------------------
|
||||
|
||||
Check whether the C compiler supports a given flag.
|
||||
|
||||
.. command:: check_c_compiler_flag
|
||||
|
||||
::
|
||||
|
||||
check_c_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>``.
|
||||
|
||||
This command temporarily sets the ``CMAKE_REQUIRED_DEFINITIONS`` variable
|
||||
and calls the ``check_c_source_compiles`` macro from the
|
||||
:module:`CheckCSourceCompiles` 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_C_FLAGS <CMAKE_<LANG>_FLAGS>`, unknown flags
|
||||
in such variables may cause a false negative for this check.
|
||||
#]=======================================================================]
|
||||
|
||||
include(CheckCSourceCompiles)
|
||||
include(CMakeCheckCompilerFlagCommonPatterns)
|
||||
|
@ -1,25 +1,36 @@
|
||||
# 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.
|
||||
#
|
||||
# CHECK_CXX_COMPILER_FLAG(<flag> <var>)
|
||||
#
|
||||
# ::
|
||||
#
|
||||
# <flag> - the compiler flag
|
||||
# <var> - variable to store the result
|
||||
#
|
||||
# This internally calls the check_cxx_source_compiles macro and sets
|
||||
# CMAKE_REQUIRED_DEFINITIONS to <flag>. See help for
|
||||
# CheckCXXSourceCompiles for a listing of variables that can otherwise
|
||||
# modify the build. The result only tells that the compiler does not
|
||||
# give an error message when it encounters the flag. If the flag has
|
||||
# any effect or even a specific one is beyond the scope of this module.
|
||||
#[=======================================================================[.rst:
|
||||
CheckCXXCompilerFlag
|
||||
------------------------
|
||||
|
||||
Check whether the CXX compiler supports a given flag.
|
||||
|
||||
.. command:: check_cxx_compiler_flag
|
||||
|
||||
::
|
||||
|
||||
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>``.
|
||||
|
||||
This command temporarily sets the ``CMAKE_REQUIRED_DEFINITIONS`` variable
|
||||
and calls the ``check_cxx_source_compiles`` macro from the
|
||||
:module:`CheckCXXSourceCompiles` 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_CXX_FLAGS <CMAKE_<LANG>_FLAGS>`, unknown flags
|
||||
in such variables may cause a false negative for this check.
|
||||
#]=======================================================================]
|
||||
|
||||
include(CheckCXXSourceCompiles)
|
||||
include(CMakeCheckCompilerFlagCommonPatterns)
|
||||
|
@ -1,27 +1,36 @@
|
||||
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
||||
# file Copyright.txt or https://cmake.org/licensing for details.
|
||||
|
||||
#.rst:
|
||||
# CheckFortranCompilerFlag
|
||||
# ------------------------
|
||||
#
|
||||
# Check whether the Fortran compiler supports a given flag.
|
||||
#
|
||||
# CHECK_Fortran_COMPILER_FLAG(<flag> <var>)
|
||||
#
|
||||
# ::
|
||||
#
|
||||
# <flag> - the compiler flag
|
||||
# <var> - variable to store the result
|
||||
# Will be created as an internal cache variable.
|
||||
#
|
||||
# This internally calls the check_fortran_source_compiles macro and
|
||||
# sets CMAKE_REQUIRED_DEFINITIONS to <flag>. See help for
|
||||
# CheckFortranSourceCompiles for a listing of variables that can
|
||||
# otherwise modify the build. The result only tells that the compiler
|
||||
# does not give an error message when it encounters the flag. If the
|
||||
# flag has any effect or even a specific one is beyond the scope of
|
||||
# this module.
|
||||
#[=======================================================================[.rst:
|
||||
CheckFortranCompilerFlag
|
||||
------------------------
|
||||
|
||||
Check whether the Fortran compiler supports a given flag.
|
||||
|
||||
.. command:: check_fortran_compiler_flag
|
||||
|
||||
::
|
||||
|
||||
check_fortran_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>``.
|
||||
|
||||
This command temporarily sets the ``CMAKE_REQUIRED_DEFINITIONS`` variable
|
||||
and calls the ``check_fortran_source_compiles`` macro from the
|
||||
:module:`CheckFortranSourceCompiles` 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_Fortran_FLAGS <CMAKE_<LANG>_FLAGS>`, unknown flags
|
||||
in such variables may cause a false negative for this check.
|
||||
#]=======================================================================]
|
||||
|
||||
include(CheckFortranSourceCompiles)
|
||||
include(CMakeCheckCompilerFlagCommonPatterns)
|
||||
|
Loading…
x
Reference in New Issue
Block a user