Browse Source

Merge topic 'doc-libfun'

7a39cfb012 Help Check{Function,Library}Exists refer to CheckSourceCompiles

Acked-by: Kitware Robot <[email protected]>
Merge-request: !9773
Brad King 1 year ago
parent
commit
74c29b44a9
2 changed files with 9 additions and 9 deletions
  1. 4 5
      Modules/CheckFunctionExists.cmake
  2. 5 4
      Modules/CheckLibraryExists.cmake

+ 4 - 5
Modules/CheckFunctionExists.cmake

@@ -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.

+ 5 - 4
Modules/CheckLibraryExists.cmake

@@ -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: