-
Notifications
You must be signed in to change notification settings - Fork 221
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
37 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
To decouple the building of a conda package from pixi we provide something what are called build backends. | ||
These are essentially executables following a specific protocol that is implemented for both pixi and the build backend. | ||
This also allows for decoupling of the build backend from pixi and it's manifest specification. | ||
|
||
The backends we are currently developing are available in the following [conda channel](https://prefix.dev/channels/pixi-build-backends). | ||
And are being developed in the [pixi-build-backends](https://github.com/prefix-dev/pixi-build-backends) repository. | ||
|
||
### Installation | ||
When looking at the following build-section: | ||
|
||
```toml | ||
--8<-- "docs/source_files/pixi_tomls/simple_pixi_build.toml:build-system" | ||
``` | ||
|
||
5. This will allow pixi to install desired backends from the `pixi-build-backends` channel, and any requirements from `conda-forge`. Backends are installed into isolated environments, and will be shared across pixi projects. | ||
|
||
### Overriding the Build Backend | ||
Sometimes you want to override the build backend that is used by pixi. Meaning overriding the backend that is specified in the [`[build-system]`](../reference/pixi_manifest.md#the-build-system). We currently have two environment variables that allow for this: | ||
|
||
1. `PIXI_BUILD_BACKEND_OVERRIDE`: This environment variable allows for overriding of one or multiple backends. Use `{name}={path}` to specify a backend name mapped to a path and `,` to separate multiple backends. | ||
For example: `pixi-build-cmake=/path/to/bin,pixi-build-python` will: | ||
1. override the `pixi-build-cmake` backend with the executable located at `/path/to/bin` | ||
2. and will use the `pixi-build-python` backend from the `PATH`. | ||
2. `PIXI_BUILD_BACKEND_OVERRIDE_ALL`: If this environment variable is set to *some* value e.g `1` or `true`, it will not install any backends in isolation and will assume that all backends are overridden and available in the `PATH`. This is useful for development purposes. e.g `PIXI_BUILD_BACKEND_OVERRIDE_ALL=1 pixi install` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters