Skip to content

docs: add some notes and warnings about cross-compilation #985

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 6, 2025
Merged

docs: add some notes and warnings about cross-compilation #985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bc1885
docs: add some notes and warnings about cross-compilation
henryiii Feb 5, 2025
75197d3
style: pre-commit fixes
pre-commit-ci[bot] Feb 5, 2025
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
2 changes: 1 addition & 1 deletion docs/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ pipx run build
````{tab} uv

```bash
uvx --from build pyproject-build --installer=uv
uv build
```

````
Expand Down
22 changes: 21 additions & 1 deletion docs/crosscompile.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,25 @@

## macOS

Unlike the other platforms, macOS has the ability to target older operating
systems with the `MACOSX_DEPLOYMENT_TARGET` variable. If that is not set, you
will get a wheel optimized for the current operating system. Popular
redistributable builders like cibuildwheel will set this for you.

:::{warning}

While CMake also allows you to specify this a few other ways, scikit-build-core
will not know you've set this and won't get the correct wheel name.

:::

### Intel to AppleSilicon

On macOS, AppleClang has excellent support for making Apple Silicon and
Universal2 binaries (both architectures in one binary). Scikit-build-core
respects `ARCHFLAGS` if `CMAKE_SYSTEM_PROCESSOR` is not in the cmake args. These
values are set by cibuildwheel when cross-compiling.
values are set by most redistributable builders like cibuildwheel when
cross-compiling.

:::{warning}

Expand All @@ -19,6 +32,13 @@ Universal2.

:::

:::{warning}

If you manually set the arch flags in other ways besides `ARCHFLAGS`, or the one
special case above, scikit-build-core will not get the right wheel name.

:::

## Windows

### Intel to ARM
Expand Down
Loading