diff options
| author | Brad King <brad.king@kitware.com> | 2014-01-16 15:21:47 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-01-16 15:21:47 (GMT) |
| commit | 45056264bbccf3d5ce9690661bbe573d8511550b (patch) | |
| tree | 0f9587c11da7ccc14c2f0fd75859157c71c620bb /Help/variable | |
| parent | 0d2318dedd4c80a85b3b3e337148a9e4f7629549 (diff) | |
| download | CMake-45056264bbccf3d5ce9690661bbe573d8511550b.zip CMake-45056264bbccf3d5ce9690661bbe573d8511550b.tar.gz CMake-45056264bbccf3d5ce9690661bbe573d8511550b.tar.bz2 | |
Help: Document CMAKE_OSX_* variables
Add documentation entries for variables
CMAKE_OSX_ARCHITECTURES
CMAKE_OSX_DEPLOYMENT_TARGET
CMAKE_OSX_SYSROOT
Explain what each does and when/how they should be set.
Diffstat (limited to 'Help/variable')
| -rw-r--r-- | Help/variable/CMAKE_OSX_ARCHITECTURES.rst | 10 | ||||
| -rw-r--r-- | Help/variable/CMAKE_OSX_DEPLOYMENT_TARGET.rst | 13 | ||||
| -rw-r--r-- | Help/variable/CMAKE_OSX_SYSROOT.rst | 13 | ||||
| -rw-r--r-- | Help/variable/CMAKE_OSX_VARIABLE.txt | 6 |
4 files changed, 42 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_OSX_ARCHITECTURES.rst b/Help/variable/CMAKE_OSX_ARCHITECTURES.rst new file mode 100644 index 0000000..b9de518 --- /dev/null +++ b/Help/variable/CMAKE_OSX_ARCHITECTURES.rst @@ -0,0 +1,10 @@ +CMAKE_OSX_ARCHITECTURES +----------------------- + +Target specific architectures for OS X. + +This variable is used to initialize the :prop_tgt:`OSX_ARCHITECTURES` +property on each target as it is creaed. See that target property +for additional information. + +.. include:: CMAKE_OSX_VARIABLE.txt diff --git a/Help/variable/CMAKE_OSX_DEPLOYMENT_TARGET.rst b/Help/variable/CMAKE_OSX_DEPLOYMENT_TARGET.rst new file mode 100644 index 0000000..4fb2caa --- /dev/null +++ b/Help/variable/CMAKE_OSX_DEPLOYMENT_TARGET.rst @@ -0,0 +1,13 @@ +CMAKE_OSX_DEPLOYMENT_TARGET +--------------------------- + +Specify the minimum version of OS X on which the target binaries are +to be deployed. CMake uses this value for the ``-mmacosx-version-min`` +flag and to help choose the default SDK +(see :variable:`CMAKE_OSX_SYSROOT`). + +If not set explicitly the value is initialized by the +``MACOSX_DEPLOYMENT_TARGET`` environment variable, if set, +and otherwise computed based on the host platform. + +.. include:: CMAKE_OSX_VARIABLE.txt diff --git a/Help/variable/CMAKE_OSX_SYSROOT.rst b/Help/variable/CMAKE_OSX_SYSROOT.rst new file mode 100644 index 0000000..f1d58c6 --- /dev/null +++ b/Help/variable/CMAKE_OSX_SYSROOT.rst @@ -0,0 +1,13 @@ +CMAKE_OSX_SYSROOT +----------------- + +Specify the location or name of the OS X platform SDK to be used. +CMake uses this value to compute the value of the ``-isysroot`` flag +or equivalent and to help the ``find_*`` commands locate files in +the SDK. + +If not set explicitly the value is initialized by the ``SDKROOT`` +environment variable, if set, and otherwise computed based on the +:variable:`CMAKE_OSX_DEPLOYMENT_TARGET` or the host platform. + +.. include:: CMAKE_OSX_VARIABLE.txt diff --git a/Help/variable/CMAKE_OSX_VARIABLE.txt b/Help/variable/CMAKE_OSX_VARIABLE.txt new file mode 100644 index 0000000..385f871 --- /dev/null +++ b/Help/variable/CMAKE_OSX_VARIABLE.txt @@ -0,0 +1,6 @@ +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 is ignored on platforms other than OS X. |