mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-01 19:30:13 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help: Clarify version specification in CMAKE_GENERATOR_INSTANCE

Browse Source 
Improve the documentation added by commit ec8d37b3b1 (VS: Support
version specification in CMAKE_GENERATOR_INSTANCE, 2021-10-26,
v3.23.0-rc1~452^2~1).

Fixes: #23225
This commit is contained in:
Brad King
2022-02-14 12:21:59 -05:00
parent ba1f706768
commit e163908a76
1 changed files with 22 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
Help/variable/CMAKE_GENERATOR_INSTANCE.rst
View File

@@ -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