summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-12-17 16:09:21 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-12-17 16:11:24 (GMT)
commit37a30f228a196da9af71ab6655aa2d6e510d02f1 (patch)
tree4dc175964e256d7856d589d3fb31a98e0c390038 /Help/variable
parent2d17101269159ce9280588f95f1925408bee44e1 (diff)
parent557ea4614ee9352cbfff7798033175230a39e0e0 (diff)
downloadCMake-37a30f228a196da9af71ab6655aa2d6e510d02f1.zip
CMake-37a30f228a196da9af71ab6655aa2d6e510d02f1.tar.gz
CMake-37a30f228a196da9af71ab6655aa2d6e510d02f1.tar.bz2
Merge topic 'fix-vs-winrt-by-default'
557ea4614e VS: Change CMAKE_VS_WINRT_BY_DEFAULT to not implicitly enable WinRT 7bcef355bf Vs: Add test for VS_WINRT_BY_DEFAULT Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !4127
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_VS_WINRT_BY_DEFAULT.rst14
1 files changed, 12 insertions, 2 deletions
diff --git a/Help/variable/CMAKE_VS_WINRT_BY_DEFAULT.rst b/Help/variable/CMAKE_VS_WINRT_BY_DEFAULT.rst
index 2ba8fe2..2eea424 100644
--- a/Help/variable/CMAKE_VS_WINRT_BY_DEFAULT.rst
+++ b/Help/variable/CMAKE_VS_WINRT_BY_DEFAULT.rst
@@ -1,8 +1,18 @@
CMAKE_VS_WINRT_BY_DEFAULT
-------------------------
-Tell :ref:`Visual Studio Generators` for VS 2010 and above that the
-target platform compiles as WinRT by default (compiles with ``/ZW``).
+Inform :ref:`Visual Studio Generators` for VS 2010 and above that the
+target platform enables WinRT compilation by default and it needs to
+be explicitly disabled if ``/ZW`` or :prop_tgt:`VS_WINRT_COMPONENT` is
+omitted (as opposed to enabling it when either of those options is
+present)
+
+This makes cmake configuration consistent in terms of WinRT among
+platforms - if you did not enable the WinRT compilation explicitly, it
+will be disabled (by either not enabling it or explicitly disabling it)
+
+Note: WinRT compilation is always explicitly disabled for C language
+source files, even if it is expliclty enabled for a project
This variable is meant to be set by a
:variable:`toolchain file <CMAKE_TOOLCHAIN_FILE>` for such platforms.