summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorMartin Storsjö <martin@martin.st>2023-03-24 10:59:23 +0200
committerBrad King <brad.king@kitware.com>2023-03-24 11:57:01 -0400
commit4d23636694f88c5a34926bae1f26d90a229d6773 (patch)
tree010c25890751bc29df782805a5ae127299f61e79 /Help
parentc4c4ca0e87a900bf077b05b79b9a2198ec7493d6 (diff)
downloadcmake-4d23636694f88c5a34926bae1f26d90a229d6773.tar.gz
Warn if CMAKE_CROSSCOMPILING is true without CMAKE_SYSTEM_NAME set
Also clarify the `CMAKE_CROSSCOMPILING` documentation to state that CMake sets the variable automatically.
Diffstat (limited to 'Help')
-rw-r--r--Help/variable/CMAKE_CROSSCOMPILING.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/Help/variable/CMAKE_CROSSCOMPILING.rst b/Help/variable/CMAKE_CROSSCOMPILING.rst
index 7e6ec3371f..16dbfa59c5 100644
--- a/Help/variable/CMAKE_CROSSCOMPILING.rst
+++ b/Help/variable/CMAKE_CROSSCOMPILING.rst
@@ -1,15 +1,15 @@
CMAKE_CROSSCOMPILING
--------------------
-Intended to indicate whether CMake is cross compiling, but note limitations
-discussed below.
+This variable is set by CMake to indicate whether it is cross compiling,
+but note limitations discussed below.
This variable will be set to true by CMake if the :variable:`CMAKE_SYSTEM_NAME`
variable has been set manually (i.e. in a toolchain file or as a cache entry
from the :manual:`cmake <cmake(1)>` command line). In most cases, manually
-setting :variable:`CMAKE_SYSTEM_NAME` will only be done when cross compiling,
-since it will otherwise be given the same value as
-:variable:`CMAKE_HOST_SYSTEM_NAME` if not manually set, which is correct for
+setting :variable:`CMAKE_SYSTEM_NAME` will only be done when cross compiling
+since, if not manually set, it will be given the same value as
+:variable:`CMAKE_HOST_SYSTEM_NAME`, which is correct for
the non-cross-compiling case. In the event that :variable:`CMAKE_SYSTEM_NAME`
is manually set to the same value as :variable:`CMAKE_HOST_SYSTEM_NAME`, then
``CMAKE_CROSSCOMPILING`` will still be set to true.