summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-10-26 19:13:53 (GMT)
committerBrad King <brad.king@kitware.com>2021-10-29 15:52:58 (GMT)
commit8e6d930e8c3fb951e3c4388cc6a9a96dedcb412b (patch)
treefdf30764ab7d82ca8d4cfac17521d9a0d04987ac /Help
parent5d1f377737a9d1d14f4925072c46201d6b7b3c30 (diff)
downloadCMake-8e6d930e8c3fb951e3c4388cc6a9a96dedcb412b.zip
CMake-8e6d930e8c3fb951e3c4388cc6a9a96dedcb412b.tar.gz
CMake-8e6d930e8c3fb951e3c4388cc6a9a96dedcb412b.tar.bz2
VS: Parse comma-separated fields from CMAKE_GENERATOR_INSTANCE
Diffstat (limited to 'Help')
-rw-r--r--Help/variable/CMAKE_GENERATOR_INSTANCE.rst13
1 files changed, 12 insertions, 1 deletions
diff --git a/Help/variable/CMAKE_GENERATOR_INSTANCE.rst b/Help/variable/CMAKE_GENERATOR_INSTANCE.rst
index 5a76f09..57dba53 100644
--- a/Help/variable/CMAKE_GENERATOR_INSTANCE.rst
+++ b/Help/variable/CMAKE_GENERATOR_INSTANCE.rst
@@ -26,7 +26,18 @@ Visual Studio Instance Selection
:ref:`Visual Studio Generators` support instance specification for
Visual Studio 2017 and above. The ``CMAKE_GENERATOR_INSTANCE`` variable
may be set as a cache entry selecting an instance of Visual Studio
-via the absolute path to the top-level directory of the VS installation.
+via one of the following forms:
+
+* ``location``
+* ``location[,key=value]*``
+* ``key=value[,key=value]*``
+
+The ``location`` specifies the absolute path to the top-level directory
+of the VS installation.
+
+The ``key=value`` pairs form a comma-separated list of options to
+specify details of the instance selection.
+There are no supported pairs: this syntax is reserved for future use.
If the value of ``CMAKE_GENERATOR_INSTANCE`` is not specified explicitly
by the user or a toolchain file, CMake queries the Visual Studio Installer