diff options
author | Kitware Robot <kwrobot@kitware.com> | 2018-10-22 14:31:08 (GMT) |
---|---|---|
committer | Kyle Edwards <kyle.edwards@kitware.com> | 2018-10-22 15:09:34 (GMT) |
commit | df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56 (patch) | |
tree | 4617dc2407a2e8e9c2bfdf77f09bdd396a9823e0 /Modules/CMakePushCheckState.cmake | |
parent | 7115aa6c2249ec368fe0dfbd257a22eb0e04042d (diff) | |
download | CMake-df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56.zip CMake-df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56.tar.gz CMake-df4ed1e9ffcdb6b99ccff9e6f44808fdd2abda56.tar.bz2 |
Help: Convert remaining modules to block-style comments
Diffstat (limited to 'Modules/CMakePushCheckState.cmake')
-rw-r--r-- | Modules/CMakePushCheckState.cmake | 69 |
1 files changed, 35 insertions, 34 deletions
diff --git a/Modules/CMakePushCheckState.cmake b/Modules/CMakePushCheckState.cmake index 98eea05..7628d1a 100644 --- a/Modules/CMakePushCheckState.cmake +++ b/Modules/CMakePushCheckState.cmake @@ -1,40 +1,41 @@ # Distributed under the OSI-approved BSD 3-Clause License. See accompanying # file Copyright.txt or https://cmake.org/licensing for details. -#.rst: -# CMakePushCheckState -# ------------------- -# -# -# -# This module defines three macros: CMAKE_PUSH_CHECK_STATE() -# CMAKE_POP_CHECK_STATE() and CMAKE_RESET_CHECK_STATE() These macros can -# be used to save, restore and reset (i.e., clear contents) the state of -# the variables CMAKE_REQUIRED_FLAGS, CMAKE_REQUIRED_DEFINITIONS, -# CMAKE_REQUIRED_LIBRARIES, CMAKE_REQUIRED_INCLUDES and CMAKE_EXTRA_INCLUDE_FILES -# used by the various Check-files coming with CMake, like e.g. -# check_function_exists() etc. The variable contents are pushed on a -# stack, pushing multiple times is supported. This is useful e.g. when -# executing such tests in a Find-module, where they have to be set, but -# after the Find-module has been executed they should have the same -# value as they had before. -# -# CMAKE_PUSH_CHECK_STATE() macro receives optional argument RESET. -# Whether it's specified, CMAKE_PUSH_CHECK_STATE() will set all -# CMAKE_REQUIRED_* variables to empty values, same as -# CMAKE_RESET_CHECK_STATE() call will do. -# -# Usage: -# -# :: -# -# cmake_push_check_state(RESET) -# set(CMAKE_REQUIRED_DEFINITIONS -DSOME_MORE_DEF) -# check_function_exists(...) -# cmake_reset_check_state() -# set(CMAKE_REQUIRED_DEFINITIONS -DANOTHER_DEF) -# check_function_exists(...) -# cmake_pop_check_state() +#[=======================================================================[.rst: +CMakePushCheckState +------------------- + + + +This module defines three macros: CMAKE_PUSH_CHECK_STATE() +CMAKE_POP_CHECK_STATE() and CMAKE_RESET_CHECK_STATE() These macros can +be used to save, restore and reset (i.e., clear contents) the state of +the variables CMAKE_REQUIRED_FLAGS, CMAKE_REQUIRED_DEFINITIONS, +CMAKE_REQUIRED_LIBRARIES, CMAKE_REQUIRED_INCLUDES and CMAKE_EXTRA_INCLUDE_FILES +used by the various Check-files coming with CMake, like e.g. +check_function_exists() etc. The variable contents are pushed on a +stack, pushing multiple times is supported. This is useful e.g. when +executing such tests in a Find-module, where they have to be set, but +after the Find-module has been executed they should have the same +value as they had before. + +CMAKE_PUSH_CHECK_STATE() macro receives optional argument RESET. +Whether it's specified, CMAKE_PUSH_CHECK_STATE() will set all +CMAKE_REQUIRED_* variables to empty values, same as +CMAKE_RESET_CHECK_STATE() call will do. + +Usage: + +:: + + cmake_push_check_state(RESET) + set(CMAKE_REQUIRED_DEFINITIONS -DSOME_MORE_DEF) + check_function_exists(...) + cmake_reset_check_state() + set(CMAKE_REQUIRED_DEFINITIONS -DANOTHER_DEF) + check_function_exists(...) + cmake_pop_check_state() +#]=======================================================================] macro(CMAKE_RESET_CHECK_STATE) |