Browse Source

Merge topic 'doc-check-flags'

293ecfe CheckC*CompilerFlag: add documentation what to expect from a positive result
Brad King 12 years ago
parent
commit
889527aa9c
2 changed files with 6 additions and 0 deletions
  1. 3 0
      Modules/CheckCCompilerFlag.cmake
  2. 3 0
      Modules/CheckCXXCompilerFlag.cmake

+ 3 - 0
Modules/CheckCCompilerFlag.cmake

@@ -6,6 +6,9 @@
 # sets CMAKE_REQUIRED_DEFINITIONS to <flag>.
 # See help for CheckCSourceCompiles for a listing of variables
 # that can otherwise modify the build.
+# The result only tells that the compiler does not give an error message when
+# it encounters the flag. If the flag has any effect or even a specific one is
+# beyond the scope of this module.
 
 #=============================================================================
 # Copyright 2006-2011 Kitware, Inc.

+ 3 - 0
Modules/CheckCXXCompilerFlag.cmake

@@ -6,6 +6,9 @@
 # sets CMAKE_REQUIRED_DEFINITIONS to <flag>.
 # See help for CheckCXXSourceCompiles for a listing of variables
 # that can otherwise modify the build.
+# The result only tells that the compiler does not give an error message when
+# it encounters the flag. If the flag has any effect or even a specific one is
+# beyond the scope of this module.
 
 #=============================================================================
 # Copyright 2006-2010 Kitware, Inc.