summaryrefslogtreecommitdiffstats
path: root/Modules/CheckCSourceCompiles.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2011-01-14 12:36:59 (GMT)
committerBrad King <brad.king@kitware.com>2011-01-14 12:36:59 (GMT)
commitcabb6cd00e2c7424d2be2b8c4103ab2bb2940832 (patch)
tree5d3c026c502579d33270149d7067272d6c7a1d76 /Modules/CheckCSourceCompiles.cmake
parent4da2a5687be6ec91f8001ba0366776f775531431 (diff)
downloadCMake-cabb6cd00e2c7424d2be2b8c4103ab2bb2940832.zip
CMake-cabb6cd00e2c7424d2be2b8c4103ab2bb2940832.tar.gz
CMake-cabb6cd00e2c7424d2be2b8c4103ab2bb2940832.tar.bz2
Document Check(C|CXX)SourceCompiles behavior more clearly (#11688)
Explicitly state up front that the macros try to link an executable and that the source provided must define 'main'.
Diffstat (limited to 'Modules/CheckCSourceCompiles.cmake')
-rw-r--r--Modules/CheckCSourceCompiles.cmake4
1 files changed, 2 insertions, 2 deletions
diff --git a/Modules/CheckCSourceCompiles.cmake b/Modules/CheckCSourceCompiles.cmake
index e8bfc0c..d59fe55 100644
--- a/Modules/CheckCSourceCompiles.cmake
+++ b/Modules/CheckCSourceCompiles.cmake
@@ -1,6 +1,6 @@
-# - Check if the given C source code compiles.
+# - Check if given C source compiles and links into an executable
# CHECK_C_SOURCE_COMPILES(<code> <var> [FAIL_REGEX <fail-regex>])
-# <code> - source code to try to compile
+# <code> - source code to try to compile, must define 'main'
# <var> - variable to store whether the source code compiled
# <fail-regex> - fail if test output matches this regex
# The following variables may be set before calling this macro to