diff options
| author | Oleg Chernovskiy <adonai@xaker.ru> | 2019-06-29 14:01:14 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2019-07-02 22:45:29 (GMT) |
| commit | 16434fe303a6bd8394a07177e3cef928b446f918 (patch) | |
| tree | 04ed4581af104803e53291a06c13e62f26ea8191 | |
| parent | c56201bdac81d3d74efa9437a7ed2cef4285de6d (diff) | |
| download | CMake-16434fe303a6bd8394a07177e3cef928b446f918.zip CMake-16434fe303a6bd8394a07177e3cef928b446f918.tar.gz CMake-16434fe303a6bd8394a07177e3cef928b446f918.tar.bz2 | |
Help: Discourage using CMAKE_SOURCE_DIR in toolchain files
Fixes: #19390
| -rw-r--r-- | Help/manual/cmake-toolchains.7.rst | 8 |
1 files changed, 8 insertions, 0 deletions
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 ------------------------- |