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/variable | |
| 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/variable')
| -rw-r--r-- | Help/variable/CMAKE_VS_PLATFORM_NAME.rst | 4 | ||||
| -rw-r--r-- | Help/variable/CMAKE_VS_PLATFORM_NAME_DEFAULT.rst | 9 |
2 files changed, 12 insertions, 1 deletions
diff --git a/Help/variable/CMAKE_VS_PLATFORM_NAME.rst b/Help/variable/CMAKE_VS_PLATFORM_NAME.rst index a532743..7a4642a 100644 --- a/Help/variable/CMAKE_VS_PLATFORM_NAME.rst +++ b/Help/variable/CMAKE_VS_PLATFORM_NAME.rst @@ -1,8 +1,10 @@ CMAKE_VS_PLATFORM_NAME ---------------------- -Visual Studio target platform name. +Visual Studio target platform name used by the current generator. VS 8 and above allow project files to specify a target platform. CMake provides the name of the chosen platform in this variable. See the :variable:`CMAKE_GENERATOR_PLATFORM` variable for details. + +See also the :variable:`CMAKE_VS_PLATFORM_NAME_DEFAULT` variable. diff --git a/Help/variable/CMAKE_VS_PLATFORM_NAME_DEFAULT.rst b/Help/variable/CMAKE_VS_PLATFORM_NAME_DEFAULT.rst new file mode 100644 index 0000000..c18e6fd --- /dev/null +++ b/Help/variable/CMAKE_VS_PLATFORM_NAME_DEFAULT.rst @@ -0,0 +1,9 @@ +CMAKE_VS_PLATFORM_NAME_DEFAULT +------------------------------ + +Default for the Visual Studio target platform name for the current generator +without considering the value of the :variable:`CMAKE_GENERATOR_PLATFORM` +variable. For :ref:`Visual Studio Generators` for VS 2017 and below this is +always ``Win32``. For VS 2019 and above this is based on the host platform. + +See also the :variable:`CMAKE_VS_PLATFORM_NAME` variable. |