echo/CMake
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

CheckLanguage: Add include() to example and reword documentation

Browse Source
This commit is contained in:
Peter Kokot 2025-03-13 14:26:24 +01:00
parent 8ba32e562b
commit 7bc642a7eb
No known key found for this signature in database
GPG Key ID: A94800907AA79B36
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Modules/CheckLanguage.cmake
View File

@ -5,8 +5,9 @@
CheckLanguage CheckLanguage
------------- -------------
Check whether a language can be enabled by the :command:`enable_language` This module provides the ``check_language()`` macro to check whether a language
or :command:`project` commands: can be enabled using the :command:`enable_language` or :command:`project`
commands.
.. command:: check_language .. command:: check_language
@ -14,8 +15,8 @@ or :command:`project` commands:
check_language(<lang>) check_language(<lang>)
Try enabling language ``<lang>`` in a test project and record results This macro attempts to enable the language ``<lang>`` in a test project and
in the cache: records the results in the following cache variables:
:variable:`CMAKE_<LANG>_COMPILER` :variable:`CMAKE_<LANG>_COMPILER`
If the language can be enabled, this variable is set to the compiler If the language can be enabled, this variable is set to the compiler
@ -44,13 +45,19 @@ or :command:`project` commands:
:variable:`CMAKE_<LANG>_PLATFORM <CMAKE_HIP_PLATFORM>` :variable:`CMAKE_<LANG>_PLATFORM <CMAKE_HIP_PLATFORM>`
This variable is set to the detected GPU platform when ``<lang>`` is ``HIP``. This variable is set to the detected GPU platform when ``<lang>`` is ``HIP``.
If the variable is already set its value is always preserved. Only compatible values If this variable is already set, its value is always preserved. Only
will be considered for :variable:`CMAKE_<LANG>_COMPILER`. compatible values will be considered for :variable:`CMAKE_<LANG>_COMPILER`.
For example: Examples
^^^^^^^^
This module is useful when a project does not always require a specific language
but may need to enable it for certain parts. The following example checks for
the availability of the ``Fortran`` language and enables it if possible:
.. code-block:: cmake .. code-block:: cmake
include(CheckLanguage)
check_language(Fortran) check_language(Fortran)
if(CMAKE_Fortran_COMPILER) if(CMAKE_Fortran_COMPILER)
enable_language(Fortran) enable_language(Fortran)