summaryrefslogtreecommitdiffstats
path: root/Help/envvar
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-06-03 12:32:44 (GMT)
committerBrad King <brad.king@kitware.com>2021-06-03 12:32:44 (GMT)
commit6c34ed9b879906d1eaadad80f37f518829017789 (patch)
tree45043b460fae481ff6592a7fc016e1b893431bc7 /Help/envvar
parent9c33ff4dda643f8a93d55f9895e31dce9056134f (diff)
downloadCMake-6c34ed9b879906d1eaadad80f37f518829017789.zip
CMake-6c34ed9b879906d1eaadad80f37f518829017789.tar.gz
CMake-6c34ed9b879906d1eaadad80f37f518829017789.tar.bz2
cmake: Allow CMAKE_TOOLCHAIN_FILE to be set by environment variable
When no `CMAKE_TOOLCHAIN_FILE` is explicitly specified while creating a new build tree, check for an environment variable of the same name.
Diffstat (limited to 'Help/envvar')
-rw-r--r--Help/envvar/CMAKE_TOOLCHAIN_FILE.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Help/envvar/CMAKE_TOOLCHAIN_FILE.rst b/Help/envvar/CMAKE_TOOLCHAIN_FILE.rst
new file mode 100644
index 0000000..7ea9cea
--- /dev/null
+++ b/Help/envvar/CMAKE_TOOLCHAIN_FILE.rst
@@ -0,0 +1,12 @@
+CMAKE_TOOLCHAIN_FILE
+--------------------
+
+.. versionadded:: 3.21
+
+.. include:: ENV_VAR.txt
+
+The ``CMAKE_TOOLCHAIN_FILE`` environment variable specifies a default value
+for the :variable:`CMAKE_TOOLCHAIN_FILE` variable when there is no explicit
+configuration given on the first run while creating a new build tree.
+On later runs in an existing build tree the value persists in the cache
+as :variable:`CMAKE_TOOLCHAIN_FILE`.