CMake/Modules/TestCXXAcceptsFlag.cmake
Brad King 95c705a6a9 TestCXXAcceptsFlag: Update documentation (#14657)
Document this module as deprecated and link to CheckCXXCompilerFlag.
Fix cut-n-paste-o and format macro signature.
2013-12-19 10:41:40 -05:00

52 lines
1.9 KiB
CMake

#.rst:
# TestCXXAcceptsFlag
# ------------------
#
# Deprecated. See :module:`CheckCXXCompilerFlag`.
#
# Check if the CXX compiler accepts a flag.
#
# .. code-block:: cmake
#
# CHECK_CXX_ACCEPTS_FLAG(<flags> <variable>)
#
# ``<flags>``
# the flags to try
# ``<variable>``
# variable to store the result
#=============================================================================
# Copyright 2002-2009 Kitware, Inc.
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
# License text for the above reference.)
macro(CHECK_CXX_ACCEPTS_FLAG FLAGS VARIABLE)
if(NOT DEFINED ${VARIABLE})
message(STATUS "Checking to see if CXX compiler accepts flag ${FLAGS}")
try_compile(${VARIABLE}
${CMAKE_BINARY_DIR}
${CMAKE_ROOT}/Modules/DummyCXXFile.cxx
CMAKE_FLAGS -DCOMPILE_DEFINITIONS:STRING=${FLAGS}
OUTPUT_VARIABLE OUTPUT)
if(${VARIABLE})
message(STATUS "Checking to see if CXX compiler accepts flag ${FLAGS} - yes")
file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeOutput.log
"Determining if the CXX compiler accepts the flag ${FLAGS} passed with "
"the following output:\n${OUTPUT}\n\n")
else()
message(STATUS "Checking to see if CXX compiler accepts flag ${FLAGS} - no")
file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
"Determining if the CXX compiler accepts the flag ${FLAGS} failed with "
"the following output:\n${OUTPUT}\n\n")
endif()
endif()
endmacro()