summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2016-06-30 09:06:26 -0400
committerBrad King <brad.king@kitware.com>2016-06-30 09:06:26 -0400
commit3e4c2334b894465f1d5af385dcdea3969b089db2 (patch)
tree49cbcf4c8388d436a78e1164007bd95b3647438f
parentdd71ec2c93fdf34f8bbcaafbc05f000ef6ed6cab (diff)
parentc05d240ef7b4705e6a03d29a432412672193c11c (diff)
downloadcmake-3e4c2334b894465f1d5af385dcdea3969b089db2.tar.gz
Merge branch 'doc-updates' into release
-rw-r--r--Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst16
-rw-r--r--Modules/InstallRequiredSystemLibraries.cmake4
2 files changed, 18 insertions, 2 deletions
diff --git a/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst b/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst
index 8e43465874..0f967876b2 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_<LANG>_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.
diff --git a/Modules/InstallRequiredSystemLibraries.cmake b/Modules/InstallRequiredSystemLibraries.cmake
index aa84077c96..1c6e751e18 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.