diff options
| author | Brad King <brad.king@kitware.com> | 2019-04-19 11:40:14 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2019-04-19 11:46:13 (GMT) |
| commit | db02be85a0bcccb633b31f087cde96d95fd21e8f (patch) | |
| tree | 9814a9faa000bc83770dac6593a4b9fed890e3eb /Help/generator/Visual Studio 16 2019.rst | |
| parent | 5e98111643e22ad515afa2bf48a92573b6987115 (diff) | |
| download | CMake-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/generator/Visual Studio 16 2019.rst')
| -rw-r--r-- | Help/generator/Visual Studio 16 2019.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Help/generator/Visual Studio 16 2019.rst b/Help/generator/Visual Studio 16 2019.rst index b456554..4aec7f7 100644 --- a/Help/generator/Visual Studio 16 2019.rst +++ b/Help/generator/Visual Studio 16 2019.rst @@ -28,7 +28,8 @@ by default. Platform Selection ^^^^^^^^^^^^^^^^^^ -The default target platform name (architecture) is that of the host. +The default target platform name (architecture) is that of the host +and is provided in the :variable:`CMAKE_VS_PLATFORM_NAME_DEFAULT` variable. The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps via the :manual:`cmake(1)` ``-A`` option, to specify a target platform |