Document CheckFunctionExists more clearly (#10044)

State that the function need only be available at link time.  Refer to
CheckSymbolExists for verifying that a declaration exists.
This commit is contained in:
Brad King 2011-01-17 14:02:21 -05:00
parent 28a0403c34
commit 114c3224a4
1 changed files with 8 additions and 6 deletions

View File

@ -1,8 +1,10 @@
# - Check if the function exists. # - Check if a C function can be linked
# CHECK_FUNCTION_EXISTS(FUNCTION VARIABLE) # CHECK_FUNCTION_EXISTS(<function> <variable>)
# - macro which checks if the function exists #
# FUNCTION - the name of the function # Check that the <function> is provided by libraries on the system and
# VARIABLE - variable to store the result # 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 # The following variables may be set before calling this macro to
# modify the way the check is run: # modify the way the check is run:
@ -13,7 +15,7 @@
# CMAKE_REQUIRED_LIBRARIES = list of libraries to link # 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"); # Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details. # see accompanying file Copyright.txt for details.