summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorJames Turner <zakalawe@mac.com>2018-10-04 11:41:27 +0100
committerBrad King <brad.king@kitware.com>2018-10-04 11:23:07 -0400
commitbc57c32d7ae4d061dcf4d5a9638f74afbfd95d66 (patch)
tree32d7ca4f4e1b27912af900909f0d4ed186e211d7 /Help
parentfd02538974dd952a8639d371c2c0067d30d5469a (diff)
downloadcmake-bc57c32d7ae4d061dcf4d5a9638f74afbfd95d66.tar.gz
Help: Document CMAKE_OSX_* variables as cache entries
The variables * CMAKE_OSX_ARCHITECTURES * CMAKE_OSX_DEPLOYMENT_TARGET * CMAKE_OSX_SYSROOT should be set as cache entries. Document this explicitly.
Diffstat (limited to 'Help')
-rw-r--r--Help/variable/CMAKE_OSX_VARIABLE.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_OSX_VARIABLE.txt b/Help/variable/CMAKE_OSX_VARIABLE.txt
index 5b84726048..16f3c1a1a8 100644
--- a/Help/variable/CMAKE_OSX_VARIABLE.txt
+++ b/Help/variable/CMAKE_OSX_VARIABLE.txt
@@ -2,6 +2,8 @@ The value of this variable should be set prior to the first
:command:`project` or :command:`enable_language` command invocation
because it may influence configuration of the toolchain and flags.
It is intended to be set locally by the user creating a build tree.
+This variable should be set as a ``CACHE`` entry (or else CMake may
+remove it while initializing a cache entry of the same name).
Despite the ``OSX`` part in the variable name(s) they apply also to
other SDKs than macOS like iOS, tvOS, or watchOS.