summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorRaul Tambre <raul@tambre.ee>2020-08-29 13:26:25 +0300
committerRaul Tambre <raul@tambre.ee>2020-08-29 13:26:25 +0300
commita57beabb78c74bfe15cc11c0417c4778258664ab (patch)
treeba505d229ae151396f379813c5358e6124fca442 /Help
parent670672f10e8b720d42b44fad80472805efa9ec00 (diff)
downloadcmake-a57beabb78c74bfe15cc11c0417c4778258664ab.tar.gz
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.
Diffstat (limited to 'Help')
-rw-r--r--Help/variable/CMAKE_CUDA_HOST_COMPILER.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst b/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst
index 07342b592b..d5fcb7dbf0 100644
--- a/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst
+++ b/Help/variable/CMAKE_CUDA_HOST_COMPILER.rst
@@ -3,9 +3,9 @@ CMAKE_CUDA_HOST_COMPILER
.. versionadded:: 3.10
-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.
+When :variable:`CMAKE_CUDA_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` is
+``NVIDIA``, ``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
@@ -20,6 +20,6 @@ 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``.
+ :variable:`CMAKE_CUDA_COMPILER_ID <CMAKE_<LANG>_COMPILER_ID>` is ``NVIDIA``,
+ it does not make sense to set ``CMAKE_CUDA_HOST_COMPILER`` without also
+ setting ``CMAKE_CUDA_COMPILER`` to NVCC.