diff options
| author | Brad King <brad.king@kitware.com> | 2016-05-24 19:33:34 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2016-05-25 13:36:19 (GMT) |
| commit | d256ba078a10001883487ed6af746af5b9cd9608 (patch) | |
| tree | 094283876832165e43db22f3e5bff7205b01d761 /Help | |
| parent | fb4791b37ccea1f38b8625b31df952408ab942f3 (diff) | |
| download | CMake-d256ba078a10001883487ed6af746af5b9cd9608.zip CMake-d256ba078a10001883487ed6af746af5b9cd9608.tar.gz CMake-d256ba078a10001883487ed6af746af5b9cd9608.tar.bz2 | |
try_compile: Optionally forward custom platform variables to test project
Add a `CMAKE_TRY_COMPILE_PLATFORM_VARIABLES` variable to specify a list
of custom variables to be forwarded to a `try_compile` test project.
This will be useful for platform information modules or toolchain files
to forward some platform-specific set of variables from the host project
(perhaps set in its cache) to the test project so that it can build the
same way.
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/command/try_compile.rst | 4 | ||||
| -rw-r--r-- | Help/manual/cmake-variables.7.rst | 1 | ||||
| -rw-r--r-- | Help/release/dev/try_compile-custom-variables.rst | 7 | ||||
| -rw-r--r-- | Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst | 10 |
4 files changed, 22 insertions, 0 deletions
diff --git a/Help/command/try_compile.rst b/Help/command/try_compile.rst index 78b1bc7..7830deb 100644 --- a/Help/command/try_compile.rst +++ b/Help/command/try_compile.rst @@ -115,3 +115,7 @@ a build configuration. Set the :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` variable to specify the type of target used for the source file signature. + +Set the :variable:`CMAKE_TRY_COMPILE_PLATFORM_VARIABLES` variable to specify +variables that must be propagated into the test project. This variable is +meant for use only in toolchain files. diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index b8c8bea..85b8eae 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -298,6 +298,7 @@ Variables that Control the Build /variable/CMAKE_STATIC_LINKER_FLAGS_CONFIG /variable/CMAKE_STATIC_LINKER_FLAGS /variable/CMAKE_TRY_COMPILE_CONFIGURATION + /variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES /variable/CMAKE_TRY_COMPILE_TARGET_TYPE /variable/CMAKE_USE_RELATIVE_PATHS /variable/CMAKE_VISIBILITY_INLINES_HIDDEN diff --git a/Help/release/dev/try_compile-custom-variables.rst b/Help/release/dev/try_compile-custom-variables.rst new file mode 100644 index 0000000..539b364 --- /dev/null +++ b/Help/release/dev/try_compile-custom-variables.rst @@ -0,0 +1,7 @@ +try_compile-custom-variables +---------------------------- + +* A :variable:`CMAKE_TRY_COMPILE_PLATFORM_VARIABLES` variable was + added for use by toolchain files to specify platform-specific + variables that must be propagated by the :command:`try_compile` + command into test projects. diff --git a/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst b/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst new file mode 100644 index 0000000..8e43465 --- /dev/null +++ b/Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst @@ -0,0 +1,10 @@ +CMAKE_TRY_COMPILE_PLATFORM_VARIABLES +------------------------------------ + +List of variables that the :command:`try_compile` command source file signature +must propagate into the test project in order to target the same platform as +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`. |