summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorMarc Chevrier <marc.chevrier@gmail.com>2024-03-11 17:10:43 (GMT)
committerBrad King <brad.king@kitware.com>2024-03-12 13:00:49 (GMT)
commit922883782bb0a3f80cdfb4d959ca11834b417d77 (patch)
tree1d84ac74329e66b9f9d2b20ab0edf15fdf17168c /Help
parent04d8bc6bb9727b667b8a0d339c7803befce337f2 (diff)
downloadCMake-922883782bb0a3f80cdfb4d959ca11834b417d77.zip
CMake-922883782bb0a3f80cdfb4d959ca11834b417d77.tar.gz
CMake-922883782bb0a3f80cdfb4d959ca11834b417d77.tar.bz2
LINKER_TYPE: Document that linker tool should be in the PATH
Issue: #25748
Diffstat (limited to 'Help')
-rw-r--r--Help/variable/CMAKE_LANG_USING_LINKER_TYPE.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_LANG_USING_LINKER_TYPE.rst b/Help/variable/CMAKE_LANG_USING_LINKER_TYPE.rst
index e4d9fa6..d4714c3 100644
--- a/Help/variable/CMAKE_LANG_USING_LINKER_TYPE.rst
+++ b/Help/variable/CMAKE_LANG_USING_LINKER_TYPE.rst
@@ -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