summaryrefslogtreecommitdiffstats
path: root/Modules/CheckTypeSize.cmake
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 /Modules/CheckTypeSize.cmake
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.
Diffstat (limited to 'Modules/CheckTypeSize.cmake')
-rw-r--r--Modules/CheckTypeSize.cmake3
1 files changed, 3 insertions, 0 deletions
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.