summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2017-09-16 13:28:06 (GMT)
committerCraig Scott <craig.scott@crascit.com>2017-09-18 08:57:12 (GMT)
commit77eb212d07b9158e9d3ecb2315b04a0722088e04 (patch)
tree8cf5022c74dae1fce2a667a7bebfc48bf3136da3 /Help/variable
parentdb86cf4e7ebc3a3cb9bf29d2d39986601e6edf90 (diff)
downloadCMake-77eb212d07b9158e9d3ecb2315b04a0722088e04.zip
CMake-77eb212d07b9158e9d3ecb2315b04a0722088e04.tar.gz
CMake-77eb212d07b9158e9d3ecb2315b04a0722088e04.tar.bz2
Help: Clarify/make consistent the APPLE, UNIX and WIN32 variable docs
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/APPLE.rst5
-rw-r--r--Help/variable/UNIX.rst8
-rw-r--r--Help/variable/WIN32.rst4
3 files changed, 7 insertions, 10 deletions
diff --git a/Help/variable/APPLE.rst b/Help/variable/APPLE.rst
index 75eecf1..810d5fc 100644
--- a/Help/variable/APPLE.rst
+++ b/Help/variable/APPLE.rst
@@ -1,6 +1,5 @@
APPLE
-----
-``True`` if running on OS X.
-
-Set to ``true`` on OS X.
+Set to ``True`` when the target system is an Apple platform
+(macOS, iOS, tvOS or watchOS).
diff --git a/Help/variable/UNIX.rst b/Help/variable/UNIX.rst
index 0877b7c..49d8668 100644
--- a/Help/variable/UNIX.rst
+++ b/Help/variable/UNIX.rst
@@ -1,7 +1,7 @@
UNIX
----
-``True`` for UNIX and UNIX like operating systems.
-
-Set to ``true`` when the target system is UNIX or UNIX like (i.e.
-:variable:`APPLE` and :variable:`CYGWIN`).
+Set to ``True`` when the target system is UNIX or UNIX-like
+(e.g. :variable:`APPLE` and :variable:`CYGWIN`). The
+:variable:`CMAKE_SYSTEM_NAME` variable should be queried if
+a more specific understanding of the target system is required.
diff --git a/Help/variable/WIN32.rst b/Help/variable/WIN32.rst
index 2189069..78ab772 100644
--- a/Help/variable/WIN32.rst
+++ b/Help/variable/WIN32.rst
@@ -1,6 +1,4 @@
WIN32
-----
-``True`` on Windows systems, including Win64.
-
-Set to ``true`` when the target system is Windows.
+Set to ``True`` when the target system is Windows, including Win64.