Skip to content

[XcodeBuild] update docs for new feature #4129

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

Open
wants to merge 2 commits into
base: develop2
Choose a base branch
from
Open
Changes from all commits
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
13 changes: 11 additions & 2 deletions reference/tools/apple/xcodebuild.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ The ``Xcode.build()`` method internally implements a call to ``xcodebuild`` like

.. code:: bash

$ xcodebuild -project app.xcodeproj -configuration <configuration> -arch <architecture> <sdk> <verbosity> -target <target>/-alltargets
$ xcodebuild -project app.xcodeproj -configuration <configuration> -arch <architecture> <sdk> <verbosity> -target <target>/-alltargets <custom_params>

Where:

- ``configuration`` is the configuration, typically *Release* or *Debug*, which will be obtained
from ``settings.build_type``.
from ``settings.build_type`` unless you pass it in the parameter.
- ``architecture`` is the build architecture, a mapping from the ``settings.arch`` to the
common architectures defined by Apple 'i386', 'x86_64', 'armv7', 'arm64', etc.
- ``sdk`` is set based on the values of the ``os.sdk`` and ``os.sdk_version`` defining the
Expand All @@ -54,6 +54,15 @@ Where:
``os.sdk_version`` settings values.
- ``verbosity`` is the verbosity level for the build and can take value 'verbose' or
'quiet' if set by ``tools.build:verbosity`` in your **[conf]**
- ``custom_params`` is a list of arbitrary command line params that you can pass in the
``build_options`` parameter which is a list of strings.

Additional parameters that are passed to ``xcodebuild`` (but before ``custom_params``):

- deployment target setting according to the values of ``os`` and ``os.version`` from profile,
e.g. ``MACOSX_DEPLOYMENT_TARGET=10.15`` or ``IPHONEOS_DEPLOYMENT_TARGET=15.0``
- ``SYMROOT`` and ``OBJROOT`` pointing to the recipe build folder
- ``RUN_CLANG_STATIC_ANALYZER=NO`` to avoid running Clang static analyzer by default

conf
++++
Expand Down