Browse Source

Merge topic 'doc-updates'

c05d240e Help: Document CMAKE_TRY_COMPILE_PLATFORM_VARIABLES example
dab3ccf2 InstallRequiredSystemLibraries: Document UCRT option use case
Brad King 9 years ago
parent
commit
cff9c11de7

+ 16 - 0
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.

+ 2 - 2
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.