File: CMAKE_OSX_SYSROOT.rst

package info (click to toggle)
cmake 4.2.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 152,456 kB
  • sloc: ansic: 403,896; cpp: 303,920; sh: 4,105; python: 3,583; yacc: 3,106; lex: 1,279; f90: 538; asm: 471; lisp: 375; cs: 270; java: 266; fortran: 239; objc: 215; perl: 213; xml: 198; makefile: 111; javascript: 83; pascal: 63; tcl: 55; php: 25; ruby: 22
file content (31 lines) | stat: -rw-r--r-- 1,343 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
CMAKE_OSX_SYSROOT
-----------------

Specify the location or name of the macOS platform SDK to be used.

If not set explicitly, the value is initialized by the ``SDKROOT``
environment variable, if set.  Otherwise, the value defaults to empty,
and the compiler is expected to choose a default macOS SDK on its own.

.. versionchanged:: 4.0
  The default is now empty.  Previously a default was computed based on
  the :variable:`CMAKE_OSX_DEPLOYMENT_TARGET` or the host platform.

In order to pass an explicit macOS SDK via the compiler's ``-isysroot`` flag,
users may configure their build tree with ``-DCMAKE_OSX_SYSROOT=macosx``,
or ``export SDKROOT="$(xcrun --sdk macosx --show-sdk-path)"`` in their
environment.

Notes:

* macOS compilers in ``/usr/bin``, when not invoked with ``-isysroot``,
  search for headers in ``/usr/local/include`` before system SDK paths,
  matching the convention on many platforms.  Users on macOS-x86_64 hosts
  with Homebrew installed in ``/usr/local`` should pass an explicit SDK,
  as described above, when not building with Homebrew tools.

* Some Clang compilers have no default macOS SDK selection.  For these,
  if :variable:`CMAKE_OSX_SYSROOT` is empty, CMake will automatically pass
  ``-isysroot`` with the macOS SDK printed by ``xcrun --show-sdk-path``.

.. include:: include/CMAKE_OSX_VARIABLE.rst