summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-04-03 11:24:55 -0400
committerBrad King <brad.king@kitware.com>2023-04-05 12:06:22 -0400
commit8ecb6459345c550b77d8f689ed397137f2855fca (patch)
tree2b40b1436ee7da0ead3fbc44fc5349bad53d8f59 /Help
parentf90c8ab54ebd751600f525a3e548841e6aa16049 (diff)
downloadcmake-8ecb6459345c550b77d8f689ed397137f2855fca.tar.gz
VS: Select Windows SDK matching WindowsSDKVersion env var
In an environment established by `vcvarsall.bat` or similar, this environment variable may be set to select a Windows SDK version. If the VS generator is used in such an environment, use that SDK. This is similar to how `CMAKE_GENERATOR_INSTANCE` defaults using a `VS##0COMNTOOLS` environment variable. Fixes: #17992
Diffstat (limited to 'Help')
-rw-r--r--Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION.rst b/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION.rst
index d69bb7b274..2c14d3900d 100644
--- a/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION.rst
+++ b/Help/variable/CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION.rst
@@ -12,6 +12,14 @@ VS 2015 and above support specification of a Windows SDK version:
as documented by :ref:`Visual Studio Platform Selection`, that SDK
version is selected.
+* Otherwise, if the ``WindowsSDKVersion`` environment variable
+ is set to an available SDK version, that version is selected.
+ This is intended for use in environments established by ``vcvarsall.bat``
+ or similar scripts.
+
+ .. versionadded:: 3.27
+ This is enabled by policy :policy:`CMP0149`.
+
* Otherwise, if :variable:`CMAKE_SYSTEM_VERSION` is set to an available
SDK version, that version is selected.