From 77eb212d07b9158e9d3ecb2315b04a0722088e04 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sat, 16 Sep 2017 23:28:06 +1000 Subject: [PATCH] Help: Clarify/make consistent the APPLE, UNIX and WIN32 variable docs --- Help/variable/APPLE.rst | 5 ++--- Help/variable/UNIX.rst | 8 ++++---- Help/variable/WIN32.rst | 4 +--- 3 files changed, 7 insertions(+), 10 deletions(-) diff --git a/Help/variable/APPLE.rst b/Help/variable/APPLE.rst index 75eecf1834..810d5fc3a3 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 0877b7c075..49d866838e 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 218906955d..78ab772798 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.