Skip to content

Commit 1249cbd

Browse files
authored
Improve build_platform and providers documentation
Clarify that build_platforms are native when unspecified and that cross-compilation must be manually specified if (as in the case of osx_arm64 right now), there is no native provider available.
1 parent 919f07b commit 1249cbd

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

src/maintainer/conda_forge_yml.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,14 +129,26 @@ automatic version updates/migrations for feedstocks. The current options are
129129
build_platform
130130
--------------
131131
This is a mapping from the build platform to the host platform of the package
132-
to be built. For eg: following builds a ``osx-64`` platform from ``linux-64``
132+
to be built. e.g. the following builds a ``osx-64`` package on the ``linux-64``
133133
build platform using cross-compiling.
134134

135135
.. code-block:: yaml
136136
137137
build_platform:
138138
osx_64: linux_64
139-
139+
140+
Leaving this field empty implicitly requests to build a package natively. i.e.
141+
142+
.. code-block:: yaml
143+
144+
build_platform:
145+
linux_64: linux_64
146+
linux_ppc64le: linux_ppc64le
147+
linux_aarch64: linux_aarch64
148+
osx_64: osx_64
149+
osx_arm64: osx_arm64
150+
win_64: win_64
151+
140152
.. _build_with_mambabuild:
141153

142154
build_with_mambabuild
@@ -339,6 +351,7 @@ arches:
339351
* ``win``
340352
* ``linux_aarch64``
341353
* ``linux_ppc64le``
354+
* ``osx_arm64``
342355

343356
The following CI services are available:
344357

@@ -369,6 +382,7 @@ provider entry is equivalent to the following:
369382
win: azure
370383
linux_ppc64le: None
371384
linux_aarch64: None
385+
osx_arm64: None
372386
373387
To enable ``linux_ppc64le`` and ``linux_aarch64`` and the following:
374388

@@ -378,6 +392,8 @@ To enable ``linux_ppc64le`` and ``linux_aarch64`` and the following:
378392
linux_ppc64le: default
379393
linux_aarch64: default
380394
395+
If the ``build_platform`` for an arch is not available with the selected provider, the build will be disabled; cross-compilation must be specified manually.
396+
381397
.. _recipe_dir:
382398

383399
recipe_dir

0 commit comments

Comments
 (0)