Help: Update CMAKE_SYSTEM* and CMAKE_HOST_SYSTEM* documentation

Update to documentation for HOST/TARGET system related variables to be
consistent with current functionality.
This commit is contained in:
Jiri Malak 2014-03-04 07:25:02 +01:00 committed by Brad King
parent 74b982ce73
commit 06986afc4b
8 changed files with 32 additions and 26 deletions

View File

@ -1,7 +1,10 @@
CMAKE_HOST_SYSTEM CMAKE_HOST_SYSTEM
----------------- -----------------
Name of system cmake is being run on. Composit Name of OS CMake is being run on.
The same as CMAKE_SYSTEM but for the host system instead of the target This variable is the composite of :variable:`CMAKE_HOST_SYSTEM_NAME` and
system when cross compiling. :variable:`CMAKE_HOST_SYSTEM_VERSION`, e.g.
``${CMAKE_HOST_SYSTEM_NAME}-${CMAKE_HOST_SYSTEM_VERSION}``. If
:variable:`CMAKE_HOST_SYSTEM_VERSION` is not set, then this variable is
the same as :variable:`CMAKE_HOST_SYSTEM_NAME`.

View File

@ -3,5 +3,6 @@ CMAKE_HOST_SYSTEM_NAME
Name of the OS CMake is running on. Name of the OS CMake is running on.
The same as CMAKE_SYSTEM_NAME but for the host system instead of the On systems that have the uname command, this variable is set to the
target system when cross compiling. output of uname -s. ``Linux``, ``Windows``, and ``Darwin`` for Mac OS X
are the values found on the big three operating systems.

View File

@ -3,5 +3,6 @@ CMAKE_HOST_SYSTEM_PROCESSOR
The name of the CPU CMake is running on. The name of the CPU CMake is running on.
The same as CMAKE_SYSTEM_PROCESSOR but for the host system instead of On systems that support uname, this variable is set to the output of
the target system when cross compiling. uname -p, on windows it is set to the value of the environment variable
``PROCESSOR_ARCHITECTURE``.

View File

@ -1,7 +1,8 @@
CMAKE_HOST_SYSTEM_VERSION CMAKE_HOST_SYSTEM_VERSION
------------------------- -------------------------
OS version CMake is running on. The OS version CMake is running on.
The same as CMAKE_SYSTEM_VERSION but for the host system instead of A numeric version string for the system. On systems that support
the target system when cross compiling. uname, this variable is set to the output of uname -r. On other
systems this is set to major-minor version numbers.

View File

@ -1,9 +1,10 @@
CMAKE_SYSTEM CMAKE_SYSTEM
------------ ------------
Name of system cmake is compiling for. Composit Name of OS CMake is compiling for.
This variable is the composite of CMAKE_SYSTEM_NAME and This variable is the composite of :variable:`CMAKE_SYSTEM_NAME` and
CMAKE_SYSTEM_VERSION, like this :variable:`CMAKE_SYSTEM_VERSION`, e.g.
${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. If CMAKE_SYSTEM_VERSION ``${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}``. If
is not set, then CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME. :variable:`CMAKE_SYSTEM_VERSION` is not set, then this variable is
the same as :variable:`CMAKE_SYSTEM_NAME`.

View File

@ -3,7 +3,6 @@ CMAKE_SYSTEM_NAME
Name of the OS CMake is building for. Name of the OS CMake is building for.
This is the name of the operating system on which CMake is targeting. This is the name of the OS on which CMake is targeting. This variable
On systems that have the uname command, this variable is set to the is the same as :variable:`CMAKE_HOST_SYSTEM_NAME` if you build for the
output of uname -s. Linux, Windows, and Darwin for Mac OS X are the host system instead of the target system when cross compiling.
values found on the big three operating systems.

View File

@ -3,6 +3,6 @@ CMAKE_SYSTEM_PROCESSOR
The name of the CPU CMake is building for. The name of the CPU CMake is building for.
On systems that support uname, this variable is set to the output of This variable is the same as :variable:`CMAKE_HOST_SYSTEM_PROCESSOR` if
uname -p, on windows it is set to the value of the environment you build for the host system instead of the target system when
variable PROCESSOR_ARCHITECTURE cross compiling.

View File

@ -1,8 +1,8 @@
CMAKE_SYSTEM_VERSION CMAKE_SYSTEM_VERSION
-------------------- --------------------
OS version CMake is building for. The OS version CMake is building for.
A numeric version string for the system, on systems that support This variable is the same as :variable:`CMAKE_HOST_SYSTEM_VERSION` if
uname, this variable is set to the output of uname -r. On other you build for the host system instead of the target system when
systems this is set to major-minor version numbers. cross compiling.