From cabb6cd00e2c7424d2be2b8c4103ab2bb2940832 Mon Sep 17 00:00:00 2001
From: Brad King <brad.king@kitware.com>
Date: Fri, 14 Jan 2011 07:36:59 -0500
Subject: 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'.
---
 Modules/CheckCSourceCompiles.cmake   | 4 ++--
 Modules/CheckCXXSourceCompiles.cmake | 4 ++--
 2 files changed, 4 insertions(+), 4 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
diff --git a/Modules/CheckCXXSourceCompiles.cmake b/Modules/CheckCXXSourceCompiles.cmake
index 4502c6b..0491b37 100644
--- a/Modules/CheckCXXSourceCompiles.cmake
+++ b/Modules/CheckCXXSourceCompiles.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_CXX_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
-- 
cgit v0.12