1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-19 19:43:23 +08:00

Help: Reference CMAKE_CUDA_COMPILER_ID not CMAKE_CUDA_COMPILER

We should refer to the compiler ID in the documentation to avoid users checking
compiler executable names, since that seems fragile.
This commit is contained in:
Raul Tambre
2020-08-29 13:26:25 +03:00
parent 670672f10e
commit a57beabb78

View File

@@ -3,9 +3,9 @@ CMAKE_CUDA_HOST_COMPILER
.. versionadded:: 3.10 .. versionadded:: 3.10
When :variable:`CMAKE_CUDA_COMPILER <CMAKE_<LANG>_COMPILER>` is set to When :variable:`CMAKE_CUDA_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` is
NVIDIA ``nvcc``, ``CMAKE_CUDA_HOST_COMPILER`` selects the compiler ``NVIDIA``, ``CMAKE_CUDA_HOST_COMPILER`` selects the compiler executable to use
executable to use when compiling host code for ``CUDA`` language files. when compiling host code for ``CUDA`` language files.
This maps to the ``nvcc -ccbin`` option. This maps to the ``nvcc -ccbin`` option.
The ``CMAKE_CUDA_HOST_COMPILER`` variable may be set explicitly before CUDA is The ``CMAKE_CUDA_HOST_COMPILER`` variable may be set explicitly before CUDA is
@@ -20,6 +20,6 @@ is read-only and changes to it are undefined behavior.
.. note:: .. note::
Since ``CMAKE_CUDA_HOST_COMPILER`` is meaningful only when the Since ``CMAKE_CUDA_HOST_COMPILER`` is meaningful only when the
``CMAKE_CUDA_COMPILER`` is ``nvcc``, it does not make sense to :variable:`CMAKE_CUDA_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` is ``NVIDIA``,
set ``CMAKE_CUDA_HOST_COMPILER`` explicitly without also setting it does not make sense to set ``CMAKE_CUDA_HOST_COMPILER`` without also
``CMAKE_CUDA_COMPILER`` explicitly to be sure it is ``nvcc``. setting ``CMAKE_CUDA_COMPILER`` to NVCC.