summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2022-02-16 14:38:52 (GMT)
committerKitware Robot <kwrobot@kitware.com>2022-02-16 14:39:00 (GMT)
commit6e32d3a668c2020684e664c8c16944be88552e92 (patch)
tree5e5d393d1bb53ed4d4ab3c8dfa26834969fb679d /Help/variable
parentc46ed01fa0e73fa8a7341961937bc6c3c8f4cd39 (diff)
parente163908a762a38424aa0c9093f12382bedcc7257 (diff)
downloadCMake-6e32d3a668c2020684e664c8c16944be88552e92.zip
CMake-6e32d3a668c2020684e664c8c16944be88552e92.tar.gz
CMake-6e32d3a668c2020684e664c8c16944be88552e92.tar.bz2
Merge topic 'doc-vs-instance-version'
e163908a76 Help: Clarify version specification in CMAKE_GENERATOR_INSTANCE Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !6982
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_GENERATOR_INSTANCE.rst27
1 files changed, 22 insertions, 5 deletions
diff --git a/Help/variable/CMAKE_GENERATOR_INSTANCE.rst b/Help/variable/CMAKE_GENERATOR_INSTANCE.rst
index 6a35f17..6bfabe0 100644
--- a/Help/variable/CMAKE_GENERATOR_INSTANCE.rst
+++ b/Help/variable/CMAKE_GENERATOR_INSTANCE.rst
@@ -39,16 +39,33 @@ The ``key=value`` pairs form a comma-separated list of options to
specify details of the instance selection.
Supported pairs are:
-``version=<major>.<minor>.<MMMDD>.<BBB>``
+``version=<major>.<minor>.<date>.<build>``
.. versionadded:: 3.23
- Specify the 4-component VS Build Version.
+ Specify the 4-component VS Build Version, a.k.a. Build Number.
+ The components are:
+
+ ``<major>.<minor>``
+
+ The VS major and minor version numbers.
+ These are the same as the release version numbers.
+
+ ``<date>``
+
+ A build date in the format ``MMMDD``, where ``MMM`` is a month index
+ since an epoch used by Microsoft, and ``DD`` is a day in that month.
+
+ ``<build>``
+
+ A build index on the day represented by ``<date>``.
+
+ The build number is reported by ``vswhere`` as ``installationVersion``.
+ For example, VS 16.11.10 has build number ``16.11.32126.315``.
.. versionadded:: 3.23
- A portable VS instance may be specified that is not known to the
- Visual Studio Installer tool. The ``location`` and ``version=``
- values must both be provided.
+ A portable VS instance, which is not known to the Visual Studio Installer,
+ may be specified by providing both ``location`` and ``version=``.
If the value of ``CMAKE_GENERATOR_INSTANCE`` is not specified explicitly
by the user or a toolchain file, CMake queries the Visual Studio Installer