Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

- docs for os.sdk (apple) #1981

Merged
merged 2 commits into from
Jan 19, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions reference/config_files/settings.yml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,18 @@ are possible. These are the **default** values, but it is possible to customize
Linux:
Macos:
version: [None, "10.6", "10.7", "10.8", "10.9", "10.10", "10.11", "10.12", "10.13", "10.14", "10.15", "11.0"]
sdk: [None, "MacOSX"]
Android:
api_level: ANY
iOS:
version: ["7.0", "7.1", "8.0", "8.1", "8.2", "8.3", "9.0", "9.1", "9.2", "9.3", "10.0", "10.1", "10.2", "10.3", "11.0", "11.1", "11.2", "11.3", "11.4", "12.0", "12.1", "12.2", "12.3", "12.4", "13.0", "13.1", "13.2", "13.3", "13.4", "13.5", "13.6"]
sdk: [None, "iPhoneOS", "iPhoneSimulator"]
watchOS:
version: ["4.0", "4.1", "4.2", "4.3", "5.0", "5.1", "5.2", "5.3", "6.0", "6.1"]
sdk: [None, "watchOS", "watchSimulator"]
tvOS:
version: ["11.0", "11.1", "11.2", "11.3", "11.4", "12.0", "12.1", "12.2", "12.3", "12.4", "13.0"]
sdk: [None, "AppleTVOS", "AppleTVSimulator"]
FreeBSD:
SunOS:
AIX:
Expand Down
8 changes: 6 additions & 2 deletions reference/tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1595,6 +1595,8 @@ tools.apple_sdk_name()
def apple_sdk_name(settings)

Returns proper SDK name suitable for OS and architecture you are building for (considering simulators).
If ``self.settings.os.sdk`` setting is defined, it is used, otherwise the function tries to auto-detect based on
``self.settings.os`` and ``self.settings.arch``.

Parameters:
- **settings** (Required): Conanfile settings.
Expand Down Expand Up @@ -1623,13 +1625,15 @@ tools.apple_deployment_target_flag()

.. code-block:: python

def apple_deployment_target_flag(os_, os_version)
def apple_deployment_target_flag(os_, os_version, os_sdk=None, arch=None)

Compiler flag name which controls deployment target. For example: ``-mappletvos-version-min=9.0``

Parameters:
- **os_** (Required): OS of the settings. Usually ``self.settings.os``.
- **os_version** (Required): OS version.
- **os_version** (Required): OS version. Usually ``self.settings.os.version``.
- **os_sdk** (Optional, Defaulted to ``None``): OS SDK. Usually ``self.settings.os.sdk``. Otherwise, check :command:`xcodebuild -sdk -version`. for available SDKs.
- **arch** (Optional, Defaulted to ``None``): Architecture of the settings. Usually ``self.settings.arch``.

.. _tools_xcrun:

Expand Down