LINKER_TYPE: Document that linker tool should be in the PATH

Issue: #25748
This commit is contained in:
Marc Chevrier
2024-03-11 18:10:43 +01:00
committed by Brad King
parent 04d8bc6bb9
commit 922883782b

View File

@@ -9,6 +9,12 @@ property :prop_tgt:`LINKER_TYPE`. It can hold compiler flags for the link step
or directly the linker tool. The type of data is given by the variable
:variable:`CMAKE_<LANG>_USING_LINKER_MODE`.
.. note::
The specified linker tool is expected to be accessible through
the ``PATH`` environment variable, particularly when the
:variable:`CMAKE_<LANG>_USING_LINKER_MODE` variable is set to ``FLAG``.
For example, to specify the ``LLVM`` linker for ``GNU`` compilers, we have:
.. code-block:: cmake