summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-04-19 11:40:14 (GMT)
committerBrad King <brad.king@kitware.com>2019-04-19 11:46:13 (GMT)
commitdb02be85a0bcccb633b31f087cde96d95fd21e8f (patch)
tree9814a9faa000bc83770dac6593a4b9fed890e3eb /Help/manual
parent5e98111643e22ad515afa2bf48a92573b6987115 (diff)
downloadCMake-db02be85a0bcccb633b31f087cde96d95fd21e8f.zip
CMake-db02be85a0bcccb633b31f087cde96d95fd21e8f.tar.gz
CMake-db02be85a0bcccb633b31f087cde96d95fd21e8f.tar.bz2
VS: Provide the default platform name to project code
The value of `CMAKE_VS_PLATFORM_NAME` is computed by Visual Studio generators based on `CMAKE_GENERATOR_PLATFORM` or some default. Prior to the VS 2019 generator, the default was always `Win32`. However, for the `Visual Studio 16 2019` generator, the default is based on the host platform. Store the default in a new `CMAKE_VS_PLATFORM_NAME_DEFAULT` variable for use by project code. This is particularly useful in toolchain files because they are allowed to set `CMAKE_GENERATOR_PLATFORM` and so `CMAKE_VS_PLATFORM_NAME` is not yet known. Of course the toolchain file author knows whether it will set `CMAKE_GENERATOR_PLATFORM`, and if not then `CMAKE_VS_PLATFORM_NAME_DEFAULT` provides the platform name that will be used. Fixes: #19177
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake-variables.7.rst1
1 files changed, 1 insertions, 0 deletions
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst
index 6bb30cb..5c494b8 100644
--- a/Help/manual/cmake-variables.7.rst
+++ b/Help/manual/cmake-variables.7.rst
@@ -105,6 +105,7 @@ Variables that Provide Information
/variable/CMAKE_VS_MSBUILD_COMMAND
/variable/CMAKE_VS_NsightTegra_VERSION
/variable/CMAKE_VS_PLATFORM_NAME
+ /variable/CMAKE_VS_PLATFORM_NAME_DEFAULT
/variable/CMAKE_VS_PLATFORM_TOOLSET
/variable/CMAKE_VS_PLATFORM_TOOLSET_CUDA
/variable/CMAKE_VS_PLATFORM_TOOLSET_HOST_ARCHITECTURE