summaryrefslogtreecommitdiffstats
path: root/Help/generator
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-07-06 18:57:12 (GMT)
committerBrad King <brad.king@kitware.com>2017-07-10 15:08:11 (GMT)
commit2644e4c9fcc747d750d6a522d2b4029b172902c3 (patch)
tree2963acc6206ca304e0ddadaf210e5f34e727eb0c /Help/generator
parent372de3f8039f69b3a2edcf7120083ec4097f8bd3 (diff)
downloadCMake-2644e4c9fcc747d750d6a522d2b4029b172902c3.zip
CMake-2644e4c9fcc747d750d6a522d2b4029b172902c3.tar.gz
CMake-2644e4c9fcc747d750d6a522d2b4029b172902c3.tar.bz2
VS: Choose VS 2017 instance via environment variable
In the `Visual Studio 15 2017` generator, if the `VS150COMNTOOLS` environment variable points at a specific VS 2017 instance reported by the Visual Studio Installer tool, use that as the preferred instance. Inspired-by: Iyyappa Murugandi <iyyappam@microsoft.com> Fixes: #16846
Diffstat (limited to 'Help/generator')
-rw-r--r--Help/generator/Visual Studio 15 2017.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Help/generator/Visual Studio 15 2017.rst b/Help/generator/Visual Studio 15 2017.rst
index a88f8bc..2ac0449 100644
--- a/Help/generator/Visual Studio 15 2017.rst
+++ b/Help/generator/Visual Studio 15 2017.rst
@@ -15,6 +15,18 @@ a target platform name optionally at the end of this generator name:
``Visual Studio 15 2017 ARM``
Specify target platform ``ARM``.
+Instance Selection
+^^^^^^^^^^^^^^^^^^
+
+VS 2017 supports multiple installations on the same machine.
+CMake queries the Visual Studio Installer to locate VS instances.
+If more than one instance is installed we do not define which one
+is chosen by default. If the ``VS150COMNTOOLS`` environment variable
+is set and points to the ``Common7/Tools`` directory within one of
+the instances, that instance will be used. The environment variable
+must remain consistently set whenever CMake is re-run within a given
+build tree.
+
Toolset Selection
^^^^^^^^^^^^^^^^^