summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopher Tetreault <ctetreau@quicinc.com>2020-10-22 21:04:39 (GMT)
committerBrad King <brad.king@kitware.com>2020-10-23 13:19:29 (GMT)
commitfb95d022522c76375506bc974552a04ffd87fd23 (patch)
tree859090205c4dc15e6ee4e90cc1646996ee329e24
parent3a82ff6a11d643c4a5959f65ea538a3b60784a16 (diff)
downloadCMake-fb95d022522c76375506bc974552a04ffd87fd23.zip
CMake-fb95d022522c76375506bc974552a04ffd87fd23.tar.gz
CMake-fb95d022522c76375506bc974552a04ffd87fd23.tar.bz2
Help: Document case insensitivity for CMAKE_BUILD_TYPE
The value of CMAKE_BUILD_TYPE is case insensitive. Furthermore, the actual value of the variable will have the same casing as the user specifies on the command line.
-rw-r--r--Help/variable/CMAKE_BUILD_TYPE.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_BUILD_TYPE.rst b/Help/variable/CMAKE_BUILD_TYPE.rst
index 2d35635..405f7d5 100644
--- a/Help/variable/CMAKE_BUILD_TYPE.rst
+++ b/Help/variable/CMAKE_BUILD_TYPE.rst
@@ -18,3 +18,8 @@ in a build tree configured to build type ``Debug``, CMake will see to
having :variable:`CMAKE_C_FLAGS_DEBUG <CMAKE_<LANG>_FLAGS_DEBUG>` settings get
added to the :variable:`CMAKE_C_FLAGS <CMAKE_<LANG>_FLAGS>` settings. See
also :variable:`CMAKE_CONFIGURATION_TYPES`.
+
+Note that configuration names are case-insensitive. The value of this
+variable will be the same as it is specified when invoking CMake.
+For instance, if ``-DCMAKE_BUILD_TYPE=ReLeAsE`` is specified, then the
+value of ``CMAKE_BUILD_TYPE`` will be ``ReLeAsE``.