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.

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

docs: document how to override mkShell/stdenv for devShell #709

Merged
merged 1 commit into from
Sep 25, 2024
Merged

docs: document how to override mkShell/stdenv for devShell #709

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -917,6 +917,25 @@ craneLib.devShell {
}
```

Note that it is possible to override the underlying `mkShell` (for example to
customize the build environment further) like so:

```nix
let
moldDevShell = craneLib.devShell.override {
# For example, use the mold linker
mkShell = pkgs.mkShell.override {
stdenv = pkgs.stdenvAdapters.useMoldLinker pkgs.stdenv;
};
};
in
moldDevShell {
packages = [
# etc...
];
}
```

### `craneLib.downloadCargoPackage`

`downloadCargoPackage :: set -> drv`
Expand Down