[cmake-developers] [CMake 0015149]: Document that the CHECK_* macros create cache variables

[Mantis Bug Tracker]

The following issue has been SUBMITTED. 
====================================================================== 
http://public.kitware.com/Bug/view.php?id=15149 
====================================================================== 
Reported By:                sleske
Assigned To:                
====================================================================== 
Project:                    CMake
Issue ID:                   15149
Category:                   Documentation
Reproducibility:            N/A
Severity:                   text
Priority:                   normal
Status:                     new
====================================================================== 
Date Submitted:             2014-09-11 00:50 CEST
Last Modified:              2014-09-11 00:50 CEST
====================================================================== 
Summary:                    Document that the CHECK_* macros create cache
variables
Description: 
The various CHECK_* macros (CHECK_C_COMPILER_FLAG, CHECK_FORTRAN_FUNCTION_EXISTS
Etc.) set a result variable whose name is specified as a parameter.

However, the macros do not document that the result variable is created as a
cache variable.

While this is probaby obvious to experienced CMake users, it can be confusing
for newbies.
For example, calling multiple CHECK_* macros with the same result variable will
not work as expected, because the variable is only set once.
This should be documented.

====================================================================== 

Issue History 
Date Modified    Username       Field                    Change               
====================================================================== 
2014-09-11 00:50 sleske         New Issue                                    
======================================================================