diff options
| author | Brad King <brad.king@kitware.com> | 2017-09-19 12:13:18 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2017-09-19 12:13:39 (GMT) |
| commit | 3be6835ed198253c01e2dbc2e4e0542468bb5be4 (patch) | |
| tree | 71e675e1bdad9353e85dc14b86ffae534f91c0b2 /Help | |
| parent | 2bfb434e84f70e3fb74e490f547e64ebf4de9606 (diff) | |
| parent | 77eb212d07b9158e9d3ecb2315b04a0722088e04 (diff) | |
| download | CMake-3be6835ed198253c01e2dbc2e4e0542468bb5be4.zip CMake-3be6835ed198253c01e2dbc2e4e0542468bb5be4.tar.gz CMake-3be6835ed198253c01e2dbc2e4e0542468bb5be4.tar.bz2 | |
Merge topic 'target_system_docs'
77eb212d Help: Clarify/make consistent the APPLE, UNIX and WIN32 variable docs
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !1279
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/variable/APPLE.rst | 5 | ||||
| -rw-r--r-- | Help/variable/UNIX.rst | 8 | ||||
| -rw-r--r-- | 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 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. |