diff options
| author | Brad King <brad.king@kitware.com> | 2016-06-30 09:03:41 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2016-06-30 09:03:41 -0400 |
| commit | c05d240ef7b4705e6a03d29a432412672193c11c (patch) | |
| tree | 49cbcf4c8388d436a78e1164007bd95b3647438f | |
| parent | dab3ccf29422105fe9d200bfecb6beccdb659190 (diff) | |
| download | cmake-c05d240ef7b4705e6a03d29a432412672193c11c.tar.gz | |
Help: Document CMAKE_TRY_COMPILE_PLATFORM_VARIABLES example
Suggested-by: Hendrik Sattler <post@hendrik-sattler.de>
| -rw-r--r-- | Help/variable/CMAKE_TRY_COMPILE_PLATFORM_VARIABLES.rst | 16 |
1 files changed, 16 insertions, 0 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. |