Crate specific overrides (eg. building OpenSSL without errors out of the box) #326
Conversation
FireFragment
requested review from
Patryk27,
nmattia,
Anderssorby and
blitz
as code owners
FireFragment
changed the title
| @@ -267,6 +267,7 @@ Note that you shouldn't call `overrideAttrs` on a derivation built by Naersk | |||
| | `postInstall` | Optional hook to run after the compilation is done; inside this script, `$out/bin` contains compiled Rust binaries. Useful if your application needs e.g. custom environment variables, in which case you can simply run `wrapProgram $out/bin/your-app-name` in here. Default: `false` | | |||
| | `usePureFromTOML` | Whether to use the `fromTOML` built-in or not. When set to `false` the python package `remarshal` is used instead (in a derivation) and the JSON output is read with `builtins.fromJSON`. This is a workaround for old versions of Nix. May be used safely from Nix 2.3 onwards where all bugs in `builtins.fromTOML` seem to have been fixed. Default: `true` | | |||
| | `mode` | What to do when building the derivation. Either `build`, `check`, `test`, `fmt` or `clippy`. <br/> When set to something other than `build`, no binaries are generated. Default: `"build"` | | |||
| | `autoCrateSpecificOverrides` | Whether to automatically apply crate-specific overrides, mainly additional `buildInputs` for dependencies. <br /> For example, if you use the `openssl` crate, `pkgs.pkg-config` and `pkgs.openssl` are automatically added as buildInputs. Default: `true` | | |||
There was a problem hiding this comment.
I think having it enabled by default might create issues for users that already build with openssl and already add dependencies manually. WDYT?
EDIT: to be clear I think it's a good idea to have it enabled by default, just wondering how we can avoid breaking existing setups, esp. for people with custom openssl packages
There was a problem hiding this comment.
One idea I have is to emit a warning if there is already a derivation in buildInputs with the same name. It would not work in 100% of the cases, but it should work most of the time. Or we can just disable it by default.
There was a problem hiding this comment.
I think having it enabled by default is much nicer!
|
@FireFragment looks like there's a cargo issue in the test, do they run successfully for you? https://github.com/nix-community/naersk/actions/runs/9117568700/job/25091230219?pr=326#step:4:3064 |
There on nixpkgs 22 and lower, there is too old Rust to build OpenSSL
|
It looks like that in nixpkgs 22 and lower, the cargo and rust versions are too old to compile the Now it passes: https://github.com/FireFragment/naersk/actions/runs/9275182581 On unstable and 23.05 it always worked. |
There was a problem hiding this comment.
Thanks a ton for doing this @FireFragment, much appreciated!
This PR adds a new system of crate-specific overrides, which allows to automatically adjust build behavior to make some crates working.
This will probably be mainly adding non-rust system dependencies of crates automatically as
buildInputs, so they work out-of-the-box for users.In this PR, there is just one such override (if
openssl-sysis in dependencies, automatically providepkg-configinnativeBuildInputsandopensslinbuildInputs), but more can be now added easily in future by editingcrate_specific.nix.Summary of the changes
crate_specific.nixfor defining the crate-specific overrides easilyautoCrateSpecificOverridesoption for enabling/disabling this feature