summaryrefslogtreecommitdiffstats
path: root/Modules/CheckCXXSymbolExists.cmake
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-07-10 13:50:04 (GMT)
committerBrad King <brad.king@kitware.com>2019-07-10 13:51:38 (GMT)
commitcafaa5883a0ef4371a1435de5e56a7825679bb2b (patch)
tree51a569d6d2a9ff05838d7d3e8a802c8225d0b4c8 /Modules/CheckCXXSymbolExists.cmake
parent580c694363a74de9489090785020b5dc1fece817 (diff)
downloadCMake-cafaa5883a0ef4371a1435de5e56a7825679bb2b.zip
CMake-cafaa5883a0ef4371a1435de5e56a7825679bb2b.tar.gz
CMake-cafaa5883a0ef4371a1435de5e56a7825679bb2b.tar.bz2
CheckCXXSymbolExists: Clarify documented role
Diffstat (limited to 'Modules/CheckCXXSymbolExists.cmake')
-rw-r--r--Modules/CheckCXXSymbolExists.cmake17
1 files changed, 9 insertions, 8 deletions
diff --git a/Modules/CheckCXXSymbolExists.cmake b/Modules/CheckCXXSymbolExists.cmake
index 2cccd09..3364e2f 100644
--- a/Modules/CheckCXXSymbolExists.cmake
+++ b/Modules/CheckCXXSymbolExists.cmake
@@ -5,26 +5,27 @@
CheckCXXSymbolExists
--------------------
-Check if a symbol exists as a function, variable, or macro in C++
+Check if a symbol exists as a function, variable, or macro in ``C++``.
-.. command:: CHECK_CXX_SYMBOL_EXISTS
+.. command:: check_cxx_symbol_exists
.. code-block:: cmake
- CHECK_CXX_SYMBOL_EXISTS(<symbol> <files> <variable>)
+ check_cxx_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.
- ``CHECK_CXX_SYMBOL_EXISTS()`` can be used to check in C++ files, as
- opposed to ``CHECK_SYMBOL_EXISTS()``, which works only for ``C``.
+ ``check_cxx_symbol_exists()`` can be used to check for symbols as seen by
+ the C++ compiler, as opposed to :command:`check_symbol_exists`, which always
+ uses the ``C`` compiler.
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 :module:`CheckTypeSize`
- or :module:`CheckCXXSourceCompiles`).
+ linking. If the symbol is a type, enum value, or C++ template it will
+ not be recognized: consider using the :module:`CheckTypeSize`
+ or :module:`CheckCXXSourceCompiles` module instead.
The following variables may be set before calling this macro to modify
the way the check is run: