From dab3ccf29422105fe9d200bfecb6beccdb659190 Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 30 Jun 2016 08:52:36 -0400 Subject: InstallRequiredSystemLibraries: Document UCRT option use case Suggested-by: Hendrik Sattler --- Modules/InstallRequiredSystemLibraries.cmake | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Modules/InstallRequiredSystemLibraries.cmake b/Modules/InstallRequiredSystemLibraries.cmake index aa84077..1c6e751 100644 --- a/Modules/InstallRequiredSystemLibraries.cmake +++ b/Modules/InstallRequiredSystemLibraries.cmake @@ -25,8 +25,8 @@ # # ``CMAKE_INSTALL_UCRT_LIBRARIES`` # Set to TRUE to install the Windows Universal CRT libraries for -# app-local deployment. This is meaningful only with MSVC from -# Visual Studio 2015 or higher. +# app-local deployment (e.g. to Windows XP). This is meaningful +# only with MSVC from Visual Studio 2015 or higher. # # ``CMAKE_INSTALL_MFC_LIBRARIES`` # Set to TRUE to install the MSVC MFC runtime libraries. -- cgit v0.12 From c05d240ef7b4705e6a03d29a432412672193c11c Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 30 Jun 2016 09:03:41 -0400 Subject: Help: Document CMAKE_TRY_COMPILE_PLATFORM_VARIABLES example Suggested-by: Hendrik Sattler --- Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst b/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst index 8e43465..0f96787 100644 --- a/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst +++ b/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst @@ -8,3 +8,19 @@ the host project. This variable should not be set by project code. It is meant to be set by CMake's platform information modules for the current toolchain, or by a toolchain file when used with :variable:`CMAKE_TOOLCHAIN_FILE`. + +Variables meaningful to CMake, such as :variable:`CMAKE__FLAGS`, are +propagated automatically. The ``CMAKE_TRY_COMPILE_PLATFORM_VARIABLES`` +variable may be set to pass custom variables meaningful to a toolchain file. +For example, a toolchain file may contain: + +.. code-block:: cmake + + set(CMAKE_SYSTEM_NAME ...) + set(CMAKE_TRY_COMPILE_PLATFORM_VARIABLES MY_CUSTOM_VARIABLE) + # ... use MY_CUSTOM_VARIABLE ... + +If a user passes ``-DMY_CUSTOM_VARIABLE=SomeValue`` to CMake then this +setting will be made visible to the toolchain file both for the main +project and for test projects generated by the :command:`try_compile` +command source file signature. -- cgit v0.12