Help Check{Function,Library}Exists refer to CheckSourceCompiles

help users be aware of more general/robust CheckSourceCompiles
This commit is contained in:
scivision
2024-08-23 12:46:15 -04:00
parent cd4210eb6d
commit 7a39cfb012
2 changed files with 9 additions and 9 deletions

View File

@@ -5,7 +5,7 @@
CheckFunctionExists
-------------------
Check if a C function can be linked
Check once if a C function can be linked from system libraries.
.. command:: check_function_exists
@@ -14,8 +14,7 @@ Check if a C function can be linked
check_function_exists(<function> <variable>)
Checks that the ``<function>`` is provided by libraries on the system and store
the result in a ``<variable>``, which will be created as an internal
cache variable.
the result in internal cache variable ``<variable>``.
The following variables may be set before calling this macro to modify the
way the check is run:
@@ -34,8 +33,8 @@ way the check is run:
.. note::
Prefer using :Module:`CheckSymbolExists` instead of this module,
for the following reasons:
Prefer using :module:`CheckSymbolExists` or :module:`CheckSourceCompiles`
instead of this module, for the following reasons:
* ``check_function_exists()`` can't detect functions that are inlined
in headers or specified as a macro.

View File

@@ -5,7 +5,7 @@
CheckLibraryExists
------------------
Check if the function exists.
Check once if the function exists in system or specified library.
.. command:: CHECK_LIBRARY_EXISTS
@@ -18,10 +18,11 @@ Check if the function exists.
LIBRARY - the name of the library you are looking for
FUNCTION - the name of the function
LOCATION - location where the library should be found
VARIABLE - variable to store the result
Will be created as an internal cache variable.
VARIABLE - internal cache variable to store the result
Prefer using :module:`CheckSymbolExists` or :module:`CheckSourceCompiles`
instead of this module for more robust detection if a function is available in
a library.
The following variables may be set before calling this macro to modify
the way the check is run: