From 16434fe303a6bd8394a07177e3cef928b446f918 Mon Sep 17 00:00:00 2001 From: Oleg Chernovskiy Date: Sat, 29 Jun 2019 17:01:14 +0300 Subject: Help: Discourage using CMAKE_SOURCE_DIR in toolchain files Fixes: #19390 --- Help/manual/cmake-toolchains.7.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/Help/manual/cmake-toolchains.7.rst b/Help/manual/cmake-toolchains.7.rst index df4531b..7435d9a 100644 --- a/Help/manual/cmake-toolchains.7.rst +++ b/Help/manual/cmake-toolchains.7.rst @@ -101,6 +101,14 @@ values for the compilers. The :variable:`CMAKE_CROSSCOMPILING` variable is set to true when CMake is cross-compiling. +Note that using the :variable:`CMAKE_SOURCE_DIR` or :variable:`CMAKE_BINARY_DIR` +variables inside a toolchain file is typically undesirable. The toolchain +file is used in contexts where these variables have different values when used +in different places (e.g. as part of a call to :command:`try_compile`). In most +cases, where there is a need to evaluate paths inside a toolchain file, the more +appropriate variable to use would be :variable:`CMAKE_CURRENT_LIST_DIR`, since +it always has an unambiguous, predictable value. + Cross Compiling for Linux ------------------------- -- cgit v0.12