diff options
| author | Brad King <brad.king@kitware.com> | 2021-06-03 12:32:44 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2021-06-03 12:32:44 (GMT) |
| commit | 6c34ed9b879906d1eaadad80f37f518829017789 (patch) | |
| tree | 45043b460fae481ff6592a7fc016e1b893431bc7 /Help | |
| parent | 9c33ff4dda643f8a93d55f9895e31dce9056134f (diff) | |
| download | CMake-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')
| -rw-r--r-- | Help/envvar/CMAKE_TOOLCHAIN_FILE.rst | 12 | ||||
| -rw-r--r-- | Help/manual/cmake-env-variables.7.rst | 1 | ||||
| -rw-r--r-- | Help/release/dev/env-toolchain-file.rst | 5 | ||||
| -rw-r--r-- | Help/variable/CMAKE_TOOLCHAIN_FILE.rst | 3 |
4 files changed, 21 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`. diff --git a/Help/manual/cmake-env-variables.7.rst b/Help/manual/cmake-env-variables.7.rst index 8932abf..bfdc841 100644 --- a/Help/manual/cmake-env-variables.7.rst +++ b/Help/manual/cmake-env-variables.7.rst @@ -41,6 +41,7 @@ Environment Variables that Control the Build /envvar/CMAKE_MSVCIDE_RUN_PATH /envvar/CMAKE_NO_VERBOSE /envvar/CMAKE_OSX_ARCHITECTURES + /envvar/CMAKE_TOOLCHAIN_FILE /envvar/DESTDIR /envvar/LDFLAGS /envvar/MACOSX_DEPLOYMENT_TARGET diff --git a/Help/release/dev/env-toolchain-file.rst b/Help/release/dev/env-toolchain-file.rst new file mode 100644 index 0000000..0bcd493 --- /dev/null +++ b/Help/release/dev/env-toolchain-file.rst @@ -0,0 +1,5 @@ +env-toolchain-file +------------------ + +* The :envvar:`CMAKE_TOOLCHAIN_FILE` environment variable was added to + provide a default value for the :variable:`CMAKE_TOOLCHAIN_FILE` variable. diff --git a/Help/variable/CMAKE_TOOLCHAIN_FILE.rst b/Help/variable/CMAKE_TOOLCHAIN_FILE.rst index e462c5e..ff8d59a 100644 --- a/Help/variable/CMAKE_TOOLCHAIN_FILE.rst +++ b/Help/variable/CMAKE_TOOLCHAIN_FILE.rst @@ -10,3 +10,6 @@ platform and compiler related information. Relative paths are allowed and are interpreted first as relative to the build directory, and if not found, relative to the source directory. + +This is initialized by the :envvar:`CMAKE_TOOLCHAIN_FILE` environment +variable if it is set when a new build tree is first created. |