summaryrefslogtreecommitdiffstats
path: root/Modules/CheckIncludeFile.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-03-16 13:05:55 (GMT)
committerKitware Robot <kwrobot@kitware.com>2023-03-16 13:06:04 (GMT)
commit5f74e19abb7d9a30dfbae80ef9abf7f8cfeb74e6 (patch)
treeeb496820f318674479c6f51012fd5a23dbaf0916 /Modules/CheckIncludeFile.cmake
parent671e4172bee68cdac01f9113a5a569c312bb5c65 (diff)
parent9e1b30121fc131f97c16e7c86224704c30fe9e17 (diff)
downloadCMake-5f74e19abb7d9a30dfbae80ef9abf7f8cfeb74e6.zip
CMake-5f74e19abb7d9a30dfbae80ef9abf7f8cfeb74e6.tar.gz
CMake-5f74e19abb7d9a30dfbae80ef9abf7f8cfeb74e6.tar.bz2
Merge topic 'doc_varreq'
9e1b30121f Help:toolchain: refer to CheckSourceCompiles cf48022dc5 Help:Check*: include CMAKE_REQUIRED_* vars to dedupe Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !8300
Diffstat (limited to 'Modules/CheckIncludeFile.cmake')
-rw-r--r--Modules/CheckIncludeFile.cmake27
1 files changed, 11 insertions, 16 deletions
diff --git a/Modules/CheckIncludeFile.cmake b/Modules/CheckIncludeFile.cmake
index 5771307..1d8c9f7 100644
--- a/Modules/CheckIncludeFile.cmake
+++ b/Modules/CheckIncludeFile.cmake
@@ -21,22 +21,17 @@ Provides a macro to check if a header file can be included in ``C``.
The following variables may be set before calling this macro to modify
the way the check is run:
-``CMAKE_REQUIRED_FLAGS``
- string of compile command line flags.
-``CMAKE_REQUIRED_DEFINITIONS``
- a :ref:`;-list <CMake Language Lists>` of macros to define (-DFOO=bar).
-``CMAKE_REQUIRED_INCLUDES``
- a :ref:`;-list <CMake Language Lists>` of header search paths to pass to
- the compiler.
-``CMAKE_REQUIRED_LINK_OPTIONS``
- .. versionadded:: 3.14
- a :ref:`;-list <CMake Language Lists>` of options to add to the link command.
-``CMAKE_REQUIRED_LIBRARIES``
- a :ref:`;-list <CMake Language Lists>` of libraries to add to the link
- command. See policy :policy:`CMP0075`.
-``CMAKE_REQUIRED_QUIET``
- .. versionadded:: 3.1
- execute quietly without messages.
+.. include:: /module/CMAKE_REQUIRED_FLAGS.txt
+
+.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt
+
+.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt
+
+.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt
+
+.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt
+
+.. include:: /module/CMAKE_REQUIRED_QUIET.txt
See the :module:`CheckIncludeFiles` module to check for multiple headers
at once. See the :module:`CheckIncludeFileCXX` module to check for headers