summary refs log tree commit diff
path: root/flake.nix
diff options
context:
space:
mode:
authorAdam Joseph <adam@westernsemico.com>2022-08-22 14:37:41 -0700
committerAdam Joseph <adam@westernsemico.com>2022-08-22 14:37:41 -0700
commitaad7f1d6b36819115cdfa4ccaa9d39237bfa57c5 (patch)
treecedb460cf39697eb6532a9940ba24053310a8d64 /flake.nix
parent97d1ae99de3d753307ae55487ab3311aebbce129 (diff)
downloadnixpkgs-aad7f1d6b36819115cdfa4ccaa9d39237bfa57c5.tar
nixpkgs-aad7f1d6b36819115cdfa4ccaa9d39237bfa57c5.tar.gz
nixpkgs-aad7f1d6b36819115cdfa4ccaa9d39237bfa57c5.tar.bz2
nixpkgs-aad7f1d6b36819115cdfa4ccaa9d39237bfa57c5.tar.lz
nixpkgs-aad7f1d6b36819115cdfa4ccaa9d39237bfa57c5.tar.xz
nixpkgs-aad7f1d6b36819115cdfa4ccaa9d39237bfa57c5.tar.zst
nixpkgs-aad7f1d6b36819115cdfa4ccaa9d39237bfa57c5.zip
doc/../rust.section.md: prominently mention `buildRustXX` names
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"
Diffstat (limited to 'flake.nix')
0 files changed, 0 insertions, 0 deletions