buildRustCrate: Allow version specific dependency renaming + parameter doc #84179
Conversation
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
kolloch
added a commit
to nix-community/crate2nix
that referenced
this pull request
Apr 3, 2020
Depends on NixOS/nixpkgs#84179
andir
reviewed
Apr 9, 2020
andir
reviewed
Apr 9, 2020
andir
requested changes
Apr 9, 2020
There was a problem hiding this comment.
Two minor remarks. Overall this looks good.
I also see the need for version specific overrides for things like (native)buildInputs.
Currently you have to "switch" on the version or name attribute in the overrides if you need different native inputs for the same crate name.
We should probably consider what larger refactoring we can do additionally to ease such pains.
I know, heretic, but... I also know that this is not perfect but it is a good start, I think. It would be nice if this were part of the automatic "nixdoc" function reference. I'd like guidance if this should be part of the rust section or something else.
kolloch
force-pushed
the
build-rust-crate-multi-version-rename
branch
from
4824a32
to
bb660fe
Compare
|
Thank you for the review, @andir ! For buildInputs, the crateOverrides mechanism can be used. This PR is a bit special because it concerns the extern name with which a certain crate is used within a dependent crate. So maybe those separate concerns can be handled better but will still need to be handled differently. |
kolloch
added a commit
to nix-community/crate2nix
that referenced
this pull request
May 29, 2020
Depends on NixOS/nixpkgs#84179
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR allows version specific crate renames:
I also documented all buildRustCrate parameters.
Motivation for this change
This roughly corresponds to the following snippet in Cargo.toml:
Including multiple versions of a crate is very popular during ecosystem transitions, e.g. from futures 0.1 to futures 0.3.
Corresponding issue in crate2nix: nix-community/crate2nix#83
Things done
sandboxinnix.confon non-NixOS linux)nix build -f . buildRustCrateTestsnix-shell -p nixpkgs-review --run "nixpkgs-review wip"./result/bin/)nix path-info -Sbefore and after)