diff options
| author | Brad King <brad.king@kitware.com> | 2021-01-26 16:00:44 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2021-01-26 16:04:22 (GMT) |
| commit | 5a6379f1fd1cddd702e4f44844d20ed8e01b85ed (patch) | |
| tree | c785832ab8743940baf5c06bd20f8f908465fb23 /Help/variable/CMAKE_SYSTEM_PROCESSOR.rst | |
| parent | 1380e611e1248c7bfe3889a4f00840c1a5a41d03 (diff) | |
| download | CMake-5a6379f1fd1cddd702e4f44844d20ed8e01b85ed.zip CMake-5a6379f1fd1cddd702e4f44844d20ed8e01b85ed.tar.gz CMake-5a6379f1fd1cddd702e4f44844d20ed8e01b85ed.tar.bz2 | |
Help: Clarify meaning of CMAKE_SYSTEM_PROCESSOR
On Windows the value may not match the compiler's target architecture.
Update the documentation to state this explicitly.
Issue: #15170
Diffstat (limited to 'Help/variable/CMAKE_SYSTEM_PROCESSOR.rst')
| -rw-r--r-- | Help/variable/CMAKE_SYSTEM_PROCESSOR.rst | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/Help/variable/CMAKE_SYSTEM_PROCESSOR.rst b/Help/variable/CMAKE_SYSTEM_PROCESSOR.rst index 8ad89f1..ce16215 100644 --- a/Help/variable/CMAKE_SYSTEM_PROCESSOR.rst +++ b/Help/variable/CMAKE_SYSTEM_PROCESSOR.rst @@ -1,8 +1,13 @@ CMAKE_SYSTEM_PROCESSOR ---------------------- -The name of the CPU CMake is building for. +When not cross-compiling, this variable has the same value as the +:variable:`CMAKE_HOST_SYSTEM_PROCESSOR` variable. In many cases, +this will correspond to the target architecture for the build, but +this is not guaranteed. (E.g. on Windows, the host may be ``AMD64`` +even when using a MSVC ``cl`` compiler with a 32-bit target.) -This variable is the same as :variable:`CMAKE_HOST_SYSTEM_PROCESSOR` if -you build for the host system instead of the target system when -cross compiling. +When cross-compiling, a :variable:`CMAKE_TOOLCHAIN_FILE` should set +the ``CMAKE_SYSTEM_PROCESSOR`` variable to match target architecture +that it specifies (via :variable:`CMAKE_<LANG>_COMPILER` and perhaps +:variable:`CMAKE_<LANG>_COMPILER_TARGET`). |