winsdk_version (#3487)

* winsdk_version * Update reference/commands/config.rst Co-authored-by: Carlos Zoido <mrgalleta@gmail.com> * Update reference/config_files/global_conf.rst Co-authored-by: Carlos Zoido <mrgalleta@gmail.com> * Update reference/tools/cmake/cmaketoolchain.rst * Update reference/tools/microsoft/vcvars.rst * Update reference/tools/microsoft/msbuildtoolchain.rst --------- Co-authored-by: Carlos Zoido <mrgalleta@gmail.com> Co-authored-by: Francisco Ramírez <franchuti688@gmail.com>
conan-io · Dec 19, 2023 · 14e411e · 14e411e
1 parent 0c17e6e
commit 14e411e
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 1 deletion.
diff --git a/reference/commands/config.rst b/reference/commands/config.rst
@@ -265,6 +265,7 @@ Displays all the Conan built-in configurations. There are 2 groups:
     tools.intel:setvars_args: Custom arguments to be passed onto the setvars.sh|bat script from Intel oneAPI
     tools.meson.mesontoolchain:backend: Any Meson backend: ninja, vs, vs2010, vs2012, vs2013, vs2015, vs2017, vs2019, xcode
     tools.meson.mesontoolchain:extra_machine_files: List of paths for any additional native/cross file references to be appended to the existing Conan ones
+    tools.microsoft:winsdk_version: Use this winsdk_version in vcvars
     tools.microsoft.bash:active: If Conan is already running inside bash terminal in Windows
     tools.microsoft.bash:path: The path to the shell to run when conanfile.win_bash==True
     tools.microsoft.bash:subsystem: The subsystem to be used when conanfile.win_bash==True. Possible values: msys2, msys, cygwin, wsl, sfu

diff --git a/reference/config_files/global_conf.rst b/reference/config_files/global_conf.rst
@@ -112,6 +112,7 @@ To list all the possible configurations available, run :command:`conan config li
     tools.intel:setvars_args: Custom arguments to be passed onto the setvars.sh|bat script from Intel oneAPI
     tools.meson.mesontoolchain:backend: Any Meson backend: ninja, vs, vs2010, vs2012, vs2013, vs2015, vs2017, vs2019, xcode
     tools.meson.mesontoolchain:extra_machine_files: List of paths for any additional native/cross file references to be appended to the existing Conan ones
+    tools.microsoft:winsdk_version: Use this winsdk_version in vcvars
     tools.microsoft.bash:active: If Conan is already running inside bash terminal in Windows
     tools.microsoft.bash:path: The path to the shell to run when conanfile.win_bash==True
     tools.microsoft.bash:subsystem: The subsystem to be used when conanfile.win_bash==True. Possible values: msys2, msys, cygwin, wsl, sfu

diff --git a/reference/tools/cmake/cmaketoolchain.rst b/reference/tools/cmake/cmaketoolchain.rst
@@ -533,6 +533,7 @@ CMakeToolchain is affected by these ``[conf]`` variables:
 - **tools.build:tools.apple:enable_arc** boolean value to enable/disable ARC Apple Clang flags, e.g., ``CMAKE_XCODE_ATTRIBUTE_CLANG_ENABLE_OBJC_ARC``.
 - **tools.build:tools.apple:enable_visibility** boolean value to enable/disable Visibility Apple Clang flags, e.g., ``CMAKE_XCODE_ATTRIBUTE_GCC_SYMBOLS_PRIVATE_EXTERN``.
 - **tools.build:sysroot** defines the value of ``CMAKE_SYSROOT``.
+- **tools.microsoft:winsdk_version** Defines the ``CMAKE_SYSTEM_VERSION`` or the ``CMAKE_GENERATOR_TOOLSET`` according to CMake policy ``CMP0149``.
 - **tools.build:compiler_executables** dict-like Python object which specifies the
   compiler as key and the compiler executable path as value. Those keys will be mapped as
   follows:

diff --git a/reference/tools/microsoft/msbuildtoolchain.rst b/reference/tools/microsoft/msbuildtoolchain.rst
@@ -75,6 +75,7 @@ conf
 
 - ``tools.microsoft.msbuildtoolchain:compile_options`` dict-like object of extra compile options to be added to ``<ClCompile>`` section.
   The dict will be translated as follows: ``<[KEY]>[VALUE]</[KEY]>``.
+- ``tools.microsoft:winsdk_version`` value will define the ``<WindowsTargetPlatformVersion>`` element in the toolchain file.
 - ``tools.build:cxxflags`` list of extra C++ flags that will be appended to ``<AdditionalOptions>`` section from ``<ClCompile>`` and ``<ResourceCompile>`` one.
 - ``tools.build:cflags`` list of extra of pure C flags that will be appended to ``<AdditionalOptions>`` section from ``<ClCompile>`` and ``<ResourceCompile>`` one.
 - ``tools.build:sharedlinkflags`` list of extra linker flags that will be appended to ``<AdditionalOptions>`` section from ``<Link>`` one.

diff --git a/reference/tools/microsoft/vcvars.rst b/reference/tools/microsoft/vcvars.rst
@@ -51,7 +51,7 @@ conf
 
 - ``tools.microsoft.msbuild:installation_path`` indicates the path to Visual Studio installation folder.
   For instance: ``C:\Program Files (x86)\Microsoft Visual Studio\2019\Community``, ``C:\Program Files (x86)\Microsoft Visual Studio 14.0``, etc.
-
+- ``tools.microsoft:winsdk_version`` defines the specific winsdk version in the vcvars command line.
 
 Reference
 -----------