reactos/CMake
1
0
Fork 0
mirror of https://github.com/reactos/CMake.git synced 2025-02-12 06:51:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

CheckSymbolExists: Format documentation

Browse Source
This commit is contained in:
Brad King 2017-04-12 09:30:39 -04:00
parent b416d3e696
commit 91233d563b
1 changed files with 26 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Modules/CheckSymbolExists.cmake
View File

@ -5,34 +5,42 @@
CheckSymbolExists
-----------------
Check if a symbol exists as a function, variable, or macro
Provides a macro to check if a symbol exists as a function, variable,
or macro in ``C``.
CHECK_SYMBOL_EXISTS(<symbol> <files> <variable>)
.. command:: check_symbol_exists
Check that the <symbol> is available after including given header
<files> and store the result in a <variable>. Specify the list of
files in one argument as a semicolon-separated list.
<variable> will be created as an internal cache variable.
::
check_symbol_exists(<symbol> <files> <variable>)
Check that the ``<symbol>`` is available after including given header
``<files>`` and store the result in a ``<variable>``. Specify the list
of files in one argument as a semicolon-separated list.
``<variable>`` will be created as an internal cache variable.
If the header files define the symbol as a macro it is considered
available and assumed to work. If the header files declare the symbol
as a function or variable then the symbol must also be available for
linking. If the symbol is a type or enum value it will not be
recognized (consider using CheckTypeSize or CheckCSourceCompiles). If
the check needs to be done in C++, consider using
CHECK_CXX_SYMBOL_EXISTS(), which does the same as
CHECK_SYMBOL_EXISTS(), but in C++.
linking.
If the symbol is a type or enum value it will not be recognized
(consider using :module:`CheckTypeSize` or :module:`CheckCSourceCompiles`).
If the check needs to be done in C++, consider using
:module:`CheckCXXSymbolExists` instead.
The following variables may be set before calling this macro to modify
the way the check is run:
::
CMAKE_REQUIRED_FLAGS = string of compile command line flags
CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
CMAKE_REQUIRED_INCLUDES = list of include directories
CMAKE_REQUIRED_LIBRARIES = list of libraries to link
CMAKE_REQUIRED_QUIET = execute quietly without messages
``CMAKE_REQUIRED_FLAGS``
string of compile command line flags
``CMAKE_REQUIRED_DEFINITIONS``
list of macros to define (-DFOO=bar)
``CMAKE_REQUIRED_INCLUDES``
list of include directories
``CMAKE_REQUIRED_LIBRARIES``
list of libraries to link
``CMAKE_REQUIRED_QUIET``
execute quietly without messages
#]=======================================================================]
macro(CHECK_SYMBOL_EXISTS SYMBOL FILES VARIABLE)