diff options
| author | Brad King <brad.king@kitware.com> | 2020-07-14 19:19:56 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2020-07-14 19:22:54 (GMT) |
| commit | 7968d9d442d5582f12c9eb34e9883cc77bb1b068 (patch) | |
| tree | efd844036dc796c6131446b2fdd75e869cca9b91 /Help | |
| parent | 2da778664d3e99ada4e67a5a1b9d377f92a9f75f (diff) | |
| download | CMake-7968d9d442d5582f12c9eb34e9883cc77bb1b068.zip CMake-7968d9d442d5582f12c9eb34e9883cc77bb1b068.tar.gz CMake-7968d9d442d5582f12c9eb34e9883cc77bb1b068.tar.bz2 | |
Help: Document CMAKE_CUDA_HOST_COMPILER as specific to NVIDIA nvcc
Explain the purpose of this variable and the conditions under which
it can be set. Point out that it should not be set explicitly without
also setting `CMAKE_CUDA_COMPILER` explicitly.
Issue: #20826
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/variable/CMAKE_CUDA_HOST_COMPILER.rst | 25 |
1 files changed, 20 insertions, 5 deletions
diff --git a/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst b/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst index 34512b4..07342b5 100644 --- a/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst +++ b/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst @@ -3,8 +3,23 @@ CMAKE_CUDA_HOST_COMPILER .. versionadded:: 3.10 -Executable to use when compiling host code when compiling ``CUDA`` language -files. Maps to the ``nvcc -ccbin`` option. Will only be used by CMake on the first -configuration to determine a valid host compiler for ``CUDA``. After a valid -host compiler has been found, this value is read-only. This variable takes -priority over the :envvar:`CUDAHOSTCXX` environment variable. +When :variable:`CMAKE_CUDA_COMPILER <CMAKE_<LANG>_COMPILER>` is set to +NVIDIA ``nvcc``, ``CMAKE_CUDA_HOST_COMPILER`` selects the compiler +executable to use when compiling host code for ``CUDA`` language files. +This maps to the ``nvcc -ccbin`` option. + +The ``CMAKE_CUDA_HOST_COMPILER`` variable may be set explicitly before CUDA is +first enabled by a :command:`project` or :command:`enable_language` command. +This can be done via ``-DCMAKE_CUDA_HOST_COMPILER=...`` on the command line +or in a :ref:`toolchain file <Cross Compiling Toolchain>`. Or, one may set +the :envvar:`CUDAHOSTCXX` environment variable to provide a default value. + +Once the CUDA language is enabled, the ``CMAKE_CUDA_HOST_COMPILER`` variable +is read-only and changes to it are undefined behavior. + +.. note:: + + Since ``CMAKE_CUDA_HOST_COMPILER`` is meaningful only when the + ``CMAKE_CUDA_COMPILER`` is ``nvcc``, it does not make sense to + set ``CMAKE_CUDA_HOST_COMPILER`` explicitly without also setting + ``CMAKE_CUDA_COMPILER`` explicitly to be sure it is ``nvcc``. |