diff options
| author | Brad King <brad.king@kitware.com> | 2021-06-29 17:34:28 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2021-06-30 14:55:40 (GMT) |
| commit | e216b9bbd331e77e59634690a2be98f087acaf2c (patch) | |
| tree | bbbb4bc6d552751772045ad3993dba2ba70b8536 /Help | |
| parent | 6986a382a912f4b982f4b20a6e04ff1d773ef1eb (diff) | |
| download | CMake-e216b9bbd331e77e59634690a2be98f087acaf2c.zip CMake-e216b9bbd331e77e59634690a2be98f087acaf2c.tar.gz CMake-e216b9bbd331e77e59634690a2be98f087acaf2c.tar.bz2 | |
cmake: Allow CMAKE_BUILD_TYPE to be set by environment variable
When no `CMAKE_BUILD_TYPE` is explicitly specified while creating a new
build tree, check for an environment variable of the same name.
Issue: #20983
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/envvar/CMAKE_BUILD_TYPE.rst | 10 | ||||
| -rw-r--r-- | Help/manual/cmake-env-variables.7.rst | 1 | ||||
| -rw-r--r-- | Help/release/dev/env-init-configs.rst | 5 | ||||
| -rw-r--r-- | Help/variable/CMAKE_BUILD_TYPE.rst | 5 |
4 files changed, 19 insertions, 2 deletions
diff --git a/Help/envvar/CMAKE_BUILD_TYPE.rst b/Help/envvar/CMAKE_BUILD_TYPE.rst new file mode 100644 index 0000000..f798aff --- /dev/null +++ b/Help/envvar/CMAKE_BUILD_TYPE.rst @@ -0,0 +1,10 @@ +CMAKE_BUILD_TYPE +---------------- + +.. versionadded:: 3.22 + +.. include:: ENV_VAR.txt + +The ``CMAKE_BUILD_TYPE`` environment variable specifies a default value +for the :variable:`CMAKE_BUILD_TYPE` variable when there is no explicit +configuration given on the first run while creating a new build tree. diff --git a/Help/manual/cmake-env-variables.7.rst b/Help/manual/cmake-env-variables.7.rst index fa38588..ab974a0 100644 --- a/Help/manual/cmake-env-variables.7.rst +++ b/Help/manual/cmake-env-variables.7.rst @@ -30,6 +30,7 @@ Environment Variables that Control the Build /envvar/CMAKE_APPLE_SILICON_PROCESSOR /envvar/CMAKE_BUILD_PARALLEL_LEVEL + /envvar/CMAKE_BUILD_TYPE /envvar/CMAKE_CONFIG_TYPE /envvar/CMAKE_EXPORT_COMPILE_COMMANDS /envvar/CMAKE_GENERATOR diff --git a/Help/release/dev/env-init-configs.rst b/Help/release/dev/env-init-configs.rst new file mode 100644 index 0000000..fe334b7 --- /dev/null +++ b/Help/release/dev/env-init-configs.rst @@ -0,0 +1,5 @@ +env-init-configs +---------------- + +* The :envvar:`CMAKE_BUILD_TYPE` environment variable was added to + provide a default value for the :variable:`CMAKE_BUILD_TYPE` variable. diff --git a/Help/variable/CMAKE_BUILD_TYPE.rst b/Help/variable/CMAKE_BUILD_TYPE.rst index b29678a..9ad1481 100644 --- a/Help/variable/CMAKE_BUILD_TYPE.rst +++ b/Help/variable/CMAKE_BUILD_TYPE.rst @@ -26,8 +26,9 @@ value of ``CMAKE_BUILD_TYPE`` will be ``ReLeAsE``. This variable is initialized by the first :command:`project` or :command:`enable_language` command called in a project when a new build -tree is first created. A toolchain-specific default is chosen when a -language is enabled. +tree is first created. If the :envvar:`CMAKE_BUILD_TYPE` environment +variable is set, its value is used. Otherwise, a toolchain-specific +default is chosen when a language is enabled. See :variable:`CMAKE_CONFIGURATION_TYPES` for specifying the configuration with multi-config generators. |