mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-03-13 12:59:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'CheckLanguage-doc-cuda-host'

Browse Source 
be03265fa0 Help: Explicitly note that projects should not set CMAKE_CUDA_HOST_COMPILER
13d78bbf16 CheckLanguage: Document that CMAKE_CUDA_HOST_COMPILER should not be set alone
cfd92dece3 CheckLanguage: Modernize documentation formatting

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8670
This commit is contained in:
Brad King
2023-07-31 15:50:03 +00:00
committed by Kitware Robot
parent 7518fd6074 be03265fa0
commit eb9195e9ef
2 changed files with 40 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
Help/variable/CMAKE_CUDA_HOST_COMPILER.rst
View File

@@ -24,6 +24,13 @@ is read-only and changes to it are undefined behavior.
it does not make sense to set ``CMAKE_CUDA_HOST_COMPILER`` without also
setting ``CMAKE_CUDA_COMPILER`` to NVCC.
.. note::
Projects should not try to set ``CMAKE_CUDA_HOST_COMPILER`` to match
:variable:`CMAKE_CXX_COMPILER <CMAKE_<LANG>_COMPILER>` themselves.
It is the end-user's responsibility, not the project's, to ensure that
the C++ and CUDA compilers target the same ABI.
.. note::
Ignored when using :ref:`Visual Studio Generators`.

47
Modules/CheckLanguage.cmake
View File

@@ -5,26 +5,45 @@
CheckLanguage
-------------
Check if a language can be enabled
Check whether a language can be enabled by the :command:`enable_language`
or :command:`project` commands:
Usage:
.. command:: check_language
::
.. code-block:: cmake
check_language(<lang>)
check_language(<lang>)
where ``<lang>`` is a language that may be passed to :command:`enable_language`
such as ``Fortran``. If :variable:`CMAKE_<LANG>_COMPILER` is already defined
the check does nothing. Otherwise it tries enabling the language in a
test project. The result is cached in :variable:`CMAKE_<LANG>_COMPILER`
as the compiler that was found, or ``NOTFOUND`` if the language cannot be
enabled. For CUDA which can have an explicit host compiler, the cache
:variable:`CMAKE_CUDA_HOST_COMPILER` variable will be set if it was required
for compilation (and cleared if it was not).
Try enabling language ``<lang>`` in a test project and record results
in the cache:
Example:
:variable:`CMAKE_<LANG>_COMPILER`
If the language can be enabled, this variable is set to the compiler
that was found. If the language cannot be enabled, this variable is
set to ``NOTFOUND``.
::
If this variable is already set, either explicitly or cached by
a previous call, the check is skipped.
:variable:`CMAKE_CUDA_HOST_COMPILER`
This variable is set when ``<lang>`` is ``CUDA``.
If the check detects an explicit host compiler that is required for
compilation, this variable will be set to that compiler.
If the check detects that no explicit host compiler is needed,
this variable will be cleared.
If this variable is already set, its value is preserved only if
:variable:`CMAKE_CUDA_COMPILER <CMAKE_<LANG>_COMPILER>` is also set.
Otherwise, the check runs and overwrites
:variable:`CMAKE_CUDA_HOST_COMPILER` with a new result.
Note that :variable:`CMAKE_CUDA_HOST_COMPILER` documents it should
not be set without also setting
:variable:`CMAKE_CUDA_COMPILER <CMAKE_<LANG>_COMPILER>` to a NVCC compiler.
For example:
.. code-block:: cmake
check_language(Fortran)
if(CMAKE_Fortran_COMPILER)