cmake/Help/generator/Visual Studio 15 2017.rst

63 lines
2.2 KiB
ReStructuredText
Raw Normal View History

2016-12-03 23:28:24 +01:00
Visual Studio 15 2017
---------------------
2016-10-30 18:24:19 +01:00
2016-12-03 23:28:24 +01:00
Generates Visual Studio 15 (VS 2017) project files.
2016-10-30 18:24:19 +01:00
2018-10-28 12:09:07 +01:00
Project Types
^^^^^^^^^^^^^
2016-10-30 18:24:19 +01:00
2018-10-28 12:09:07 +01:00
Only Visual C++ and C# projects may be generated. Other types of
projects (JavaScript, Powershell, Python, etc.) are not supported.
2017-04-14 19:02:05 +02:00
2017-07-20 19:35:53 +02:00
Instance Selection
^^^^^^^^^^^^^^^^^^
VS 2017 supports multiple installations on the same machine.
2018-04-23 21:13:27 +02:00
The :variable:`CMAKE_GENERATOR_INSTANCE` variable may be set as a
cache entry containing the absolute path to a Visual Studio instance.
If the value is not specified explicitly by the user or a toolchain file,
CMake queries the Visual Studio Installer to locate VS instances, chooses
one, and sets the variable as a cache entry to hold the value persistently.
When CMake first chooses an instance, if the ``VS150COMNTOOLS`` environment
variable is set and points to the ``Common7/Tools`` directory within
one of the instances, that instance will be used. Otherwise, if more
than one instance is installed we do not define which one is chosen
by default.
2017-07-20 19:35:53 +02:00
2018-10-28 12:09:07 +01:00
Platform Selection
^^^^^^^^^^^^^^^^^^
2019-11-11 23:01:05 +01:00
The default target platform name (architecture) is ``Win32``.
2018-10-28 12:09:07 +01:00
The :variable:`CMAKE_GENERATOR_PLATFORM` variable may be set, perhaps
via the :manual:`cmake(1)` ``-A`` option, to specify a target platform
name (architecture). For example:
* ``cmake -G "Visual Studio 15 2017" -A Win32``
* ``cmake -G "Visual Studio 15 2017" -A x64``
* ``cmake -G "Visual Studio 15 2017" -A ARM``
* ``cmake -G "Visual Studio 15 2017" -A ARM64``
For compatibility with CMake versions prior to 3.1, one may specify
a target platform name optionally at the end of the generator name.
This is supported only for:
``Visual Studio 15 2017 Win64``
Specify target platform ``x64``.
``Visual Studio 15 2017 ARM``
Specify target platform ``ARM``.
2017-04-14 19:02:05 +02:00
Toolset Selection
^^^^^^^^^^^^^^^^^
The ``v141`` toolset that comes with Visual Studio 15 2017 is selected by
default. The :variable:`CMAKE_GENERATOR_TOOLSET` option may be set, perhaps
via the :manual:`cmake(1)` ``-T`` option, to specify another toolset.
2019-11-11 23:01:05 +01:00
.. |VS_TOOLSET_HOST_ARCH_DEFAULT| replace::
By default this generator uses the 32-bit variant even on a 64-bit host.
2017-04-14 19:02:05 +02:00
.. include:: VS_TOOLSET_HOST_ARCH.txt