summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Leske <sebastian.leske@sleske.name>2014-09-10 06:35:49 (GMT)
committerBrad King <brad.king@kitware.com>2014-09-11 12:55:26 (GMT)
commit908c74399a737d878e18823e00730964896d1184 (patch)
tree830fbd1030f8f12bc4b4b97065ede39c3e10799e
parent0a92b23c52675bf8fe93cb9959266a49ab509ac1 (diff)
downloadCMake-908c74399a737d878e18823e00730964896d1184.zip
CMake-908c74399a737d878e18823e00730964896d1184.tar.gz
CMake-908c74399a737d878e18823e00730964896d1184.tar.bz2
Help: Document that the CHECK_* macros create cache variables
Otherwise callers may expect to be able to re-use result variables.
-rw-r--r--Modules/CheckCCompilerFlag.cmake1
-rw-r--r--Modules/CheckCSourceCompiles.cmake1
-rw-r--r--Modules/CheckCSourceRuns.cmake1
-rw-r--r--Modules/CheckCXXSourceCompiles.cmake1
-rw-r--r--Modules/CheckCXXSourceRuns.cmake1
-rw-r--r--Modules/CheckFortranFunctionExists.cmake1
-rw-r--r--Modules/CheckFortranSourceCompiles.cmake1
-rw-r--r--Modules/CheckFunctionExists.cmake1
-rw-r--r--Modules/CheckIncludeFile.cmake1
-rw-r--r--Modules/CheckIncludeFileCXX.cmake1
-rw-r--r--Modules/CheckIncludeFiles.cmake1
-rw-r--r--Modules/CheckLibraryExists.cmake1
-rw-r--r--Modules/CheckPrototypeDefinition.cmake1
-rw-r--r--Modules/CheckSymbolExists.cmake1
-rw-r--r--Modules/CheckTypeSize.cmake3
-rw-r--r--Modules/CheckVariableExists.cmake2
16 files changed, 18 insertions, 1 deletions
diff --git a/Modules/CheckCCompilerFlag.cmake b/Modules/CheckCCompilerFlag.cmake
index efdac20..53f3454 100644
--- a/Modules/CheckCCompilerFlag.cmake
+++ b/Modules/CheckCCompilerFlag.cmake
@@ -10,6 +10,7 @@
#
# <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
diff --git a/Modules/CheckCSourceCompiles.cmake b/Modules/CheckCSourceCompiles.cmake
index 7523446..6e80fb5 100644
--- a/Modules/CheckCSourceCompiles.cmake
+++ b/Modules/CheckCSourceCompiles.cmake
@@ -10,6 +10,7 @@
#
# <code> - source code to try to compile, must define 'main'
# <var> - variable to store whether the source code compiled
+# Will be created as an internal cache variable.
# <fail-regex> - fail if test output matches this regex
#
# The following variables may be set before calling this macro to modify
diff --git a/Modules/CheckCSourceRuns.cmake b/Modules/CheckCSourceRuns.cmake
index 0fb0f23..0ce423c 100644
--- a/Modules/CheckCSourceRuns.cmake
+++ b/Modules/CheckCSourceRuns.cmake
@@ -11,6 +11,7 @@
# <code> - source code to try to compile
# <var> - variable to store the result
# (1 for success, empty for failure)
+# Will be created as an internal cache variable.
#
# The following variables may be set before calling this macro to modify
# the way the check is run:
diff --git a/Modules/CheckCXXSourceCompiles.cmake b/Modules/CheckCXXSourceCompiles.cmake
index edd62a6..6d52ec6 100644
--- a/Modules/CheckCXXSourceCompiles.cmake
+++ b/Modules/CheckCXXSourceCompiles.cmake
@@ -10,6 +10,7 @@
#
# <code> - source code to try to compile, must define 'main'
# <var> - variable to store whether the source code compiled
+# Will be created as an internal cache variable.
# <fail-regex> - fail if test output matches this regex
#
# The following variables may be set before calling this macro to modify
diff --git a/Modules/CheckCXXSourceRuns.cmake b/Modules/CheckCXXSourceRuns.cmake
index 02731f8..3c06d75 100644
--- a/Modules/CheckCXXSourceRuns.cmake
+++ b/Modules/CheckCXXSourceRuns.cmake
@@ -11,6 +11,7 @@
# <code> - source code to try to compile
# <var> - variable to store the result
# (1 for success, empty for failure)
+# Will be created as an internal cache variable.
#
# The following variables may be set before calling this macro to modify
# the way the check is run:
diff --git a/Modules/CheckFortranFunctionExists.cmake b/Modules/CheckFortranFunctionExists.cmake
index 0b12289..bd52f61 100644
--- a/Modules/CheckFortranFunctionExists.cmake
+++ b/Modules/CheckFortranFunctionExists.cmake
@@ -10,6 +10,7 @@
#
# FUNCTION - the name of the Fortran function
# VARIABLE - variable to store the result
+# Will be created as an internal cache variable.
#
#
#
diff --git a/Modules/CheckFortranSourceCompiles.cmake b/Modules/CheckFortranSourceCompiles.cmake
index 63e4539..f90d05b 100644
--- a/Modules/CheckFortranSourceCompiles.cmake
+++ b/Modules/CheckFortranSourceCompiles.cmake
@@ -12,6 +12,7 @@
# Source code to try to compile. It must define a PROGRAM entry point.
# ``<var>``
# Variable to store whether the source code compiled.
+# Will be created as an internal cache variable.
# ``<fail-regex>``
# Fail if test output matches this regex.
#
diff --git a/Modules/CheckFunctionExists.cmake b/Modules/CheckFunctionExists.cmake
index 4c4334f..d277c32 100644
--- a/Modules/CheckFunctionExists.cmake
+++ b/Modules/CheckFunctionExists.cmake
@@ -10,6 +10,7 @@
# store the result in a <variable>. This does not verify that any
# system header file declares the function, only that it can be found at
# link time (consider using CheckSymbolExists).
+# <variable> will be created as an internal cache variable.
#
# The following variables may be set before calling this macro to modify
# the way the check is run:
diff --git a/Modules/CheckIncludeFile.cmake b/Modules/CheckIncludeFile.cmake
index c217bd4..402b37c 100644
--- a/Modules/CheckIncludeFile.cmake
+++ b/Modules/CheckIncludeFile.cmake
@@ -10,6 +10,7 @@
#
# INCLUDE - name of include file
# VARIABLE - variable to return result
+# Will be created as an internal cache variable.
#
#
#
diff --git a/Modules/CheckIncludeFileCXX.cmake b/Modules/CheckIncludeFileCXX.cmake
index eff982c..eae1730 100644
--- a/Modules/CheckIncludeFileCXX.cmake
+++ b/Modules/CheckIncludeFileCXX.cmake
@@ -14,6 +14,7 @@
#
# INCLUDE - name of include file
# VARIABLE - variable to return result
+# Will be created as an internal cache variable.
#
#
#
diff --git a/Modules/CheckIncludeFiles.cmake b/Modules/CheckIncludeFiles.cmake
index f8378c0..2494862 100644
--- a/Modules/CheckIncludeFiles.cmake
+++ b/Modules/CheckIncludeFiles.cmake
@@ -12,6 +12,7 @@
#
# INCLUDE - list of files to include
# VARIABLE - variable to return result
+# Will be created as an internal cache variable.
#
#
#
diff --git a/Modules/CheckLibraryExists.cmake b/Modules/CheckLibraryExists.cmake
index fac5dd1..95c595a 100644
--- a/Modules/CheckLibraryExists.cmake
+++ b/Modules/CheckLibraryExists.cmake
@@ -12,6 +12,7 @@
# FUNCTION - the name of the function
# LOCATION - location where the library should be found
# VARIABLE - variable to store the result
+# Will be created as an internal cache variable.
#
#
#
diff --git a/Modules/CheckPrototypeDefinition.cmake b/Modules/CheckPrototypeDefinition.cmake
index fe00074..dfa54d8 100644
--- a/Modules/CheckPrototypeDefinition.cmake
+++ b/Modules/CheckPrototypeDefinition.cmake
@@ -13,6 +13,7 @@
# RETURN - The return value of the function.
# HEADER - The header files required.
# VARIABLE - The variable to store the result.
+# Will be created as an internal cache variable.
#
# Example:
#
diff --git a/Modules/CheckSymbolExists.cmake b/Modules/CheckSymbolExists.cmake
index c31f6b6..79c5ba7 100644
--- a/Modules/CheckSymbolExists.cmake
+++ b/Modules/CheckSymbolExists.cmake
@@ -9,6 +9,7 @@
# Check that the <symbol> is available after including given header
# <files> and store the result in a <variable>. Specify the list of
# files in one argument as a semicolon-separated list.
+# <variable> will be created as an internal cache variable.
#
# If the header files define the symbol as a macro it is considered
# available and assumed to work. If the header files declare the symbol
diff --git a/Modules/CheckTypeSize.cmake b/Modules/CheckTypeSize.cmake
index 8ce6b88..73ad86e 100644
--- a/Modules/CheckTypeSize.cmake
+++ b/Modules/CheckTypeSize.cmake
@@ -19,6 +19,9 @@
# "0" = type has arch-dependent size (see below)
# "" = type does not exist
#
+# Both ``HAVE_${VARIABLE}`` and ``${VARIABLE}`` will be created as internal
+# cache variables.
+#
# Furthermore, the variable "${VARIABLE}_CODE" holds C preprocessor code
# to define the macro "${VARIABLE}" to the size of the type, or leave
# the macro undefined if the type does not exist.
diff --git a/Modules/CheckVariableExists.cmake b/Modules/CheckVariableExists.cmake
index 9e8e984..f3e05e4 100644
--- a/Modules/CheckVariableExists.cmake
+++ b/Modules/CheckVariableExists.cmake
@@ -14,7 +14,7 @@
#
# VAR - the name of the variable
# VARIABLE - variable to store the result
-#
+# Will be created as an internal cache variable.
#
#
# This macro is only for C variables.