diff options
| author | Brad King <brad.king@kitware.com> | 2011-01-19 19:02:33 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2011-01-19 19:02:33 (GMT) |
| commit | 3b900dbd093e804c17ecee34c64b1380275f1138 (patch) | |
| tree | 435b86d9fbd3ed80d2717a57f6de5dd65f05d1d0 | |
| parent | db276e48c41abb0c8dcbf9c2d0726d16fc3e4871 (diff) | |
| parent | 114c3224a4934c8f5bbfa0330451583a05383062 (diff) | |
| download | CMake-3b900dbd093e804c17ecee34c64b1380275f1138.zip CMake-3b900dbd093e804c17ecee34c64b1380275f1138.tar.gz CMake-3b900dbd093e804c17ecee34c64b1380275f1138.tar.bz2 | |
Merge topic 'doc-CheckFunctionExists-clarify-issue-10044'
114c322 Document CheckFunctionExists more clearly (#10044)
| -rw-r--r-- | Modules/CheckFunctionExists.cmake | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/Modules/CheckFunctionExists.cmake b/Modules/CheckFunctionExists.cmake index e1a1777..0ba36d9 100644 --- a/Modules/CheckFunctionExists.cmake +++ b/Modules/CheckFunctionExists.cmake @@ -1,8 +1,10 @@ -# - Check if the function exists. -# CHECK_FUNCTION_EXISTS(FUNCTION VARIABLE) -# - macro which checks if the function exists -# FUNCTION - the name of the function -# VARIABLE - variable to store the result +# - Check if a C function can be linked +# CHECK_FUNCTION_EXISTS(<function> <variable>) +# +# Check that the <function> is provided by libraries on the system and +# store the result in a <variable>. This does not verify that any +# system header file declares the function, only that it can be found +# at link time (considure using CheckSymbolExists). # # The following variables may be set before calling this macro to # modify the way the check is run: @@ -13,7 +15,7 @@ # CMAKE_REQUIRED_LIBRARIES = list of libraries to link #============================================================================= -# Copyright 2002-2009 Kitware, Inc. +# Copyright 2002-2011 Kitware, Inc. # # Distributed under the OSI-approved BSD License (the "License"); # see accompanying file Copyright.txt for details. |