doc/../rust.section.md: prominently mention buildRustXX names
#187921
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
This was a source of massive confusion for me when I first learned my way around nixpkgs' rust machinery. I seek to save others from that confusion. * `buildRustPackage` should have been named `buildRustPackageUsingCargo` * `buildRustCrate` should have been named `buildRustPackageUsingNix` It is, unfortunately, too late to fix this. Let's do the next best thing and make the names `buildRustPackage` and `buildRustCrate` very prominent in the documentation, so readers see immediately that they need to learn the following jargon: * `buildRustPackage` means "build this Rust crate by calling `cargo` in one (or two) monolithic derivations" * `buildRustCrate` means "build this Rust crate by calling `rustc` in one derivation for each crate"
This was referenced Aug 22, 2022
ghost
marked this pull request as ready for review
ghost
mentioned this pull request
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.
Description of changes
This was a source of massive confusion for me when I first learned my way around nixpkgs' rust machinery:
buildRustPackageshould have been namedbuildRustCrateUsingCargobuildRustCrateshould have been namedbuildRustCrateUsingNix(or maybebuildRustCrateUsingRustC)I seek to save others from the confusion I experienced. It is, unfortunately, too late to change these names. Let's do the next best thing and make the names
buildRustPackageandbuildRustCratevery prominent in the documentation, so readers see immediately that they need to memorize the following jargon:buildRustPackagemeans "build this Rust crate by callingcargoin one (or two) monolithic derivations"buildRustCratemeans "build this Rust crate by callingrustcin one derivation for each crate"See also: #187919, #187922
Things done