mirror/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-09-29 07:32:58 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #287331 from booniepepper/doc/prefer-cargoHash-attribute

Browse Source 
doc: consistently prefer and lead with cargoHash over cargoSha256
This commit is contained in:
Silvan Mosberger 2024-02-15 16:14:03 +01:00 committed by GitHub
commit fc407cfdf9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/languages-frameworks/rust.section.md
View File

@ -44,11 +44,11 @@ rustPlatform.buildRustPackage rec {
} }
``` ```
`buildRustPackage` requires either the `cargoHash` or the `cargoSha256` `buildRustPackage` requires either a `cargoHash` (preferred) or a
attribute which is computed over all crate sources of this package. `cargoSha256` attribute, computed over all crate sources of this package.
`cargoSha256` is used for traditional Nix SHA-256 hashes. `cargoHash` should `cargoHash` supports [SRI](https://www.w3.org/TR/SRI/) hashes and should be
instead be used for [SRI](https://www.w3.org/TR/SRI/) hashes and should be preferred over `cargoSha256` which was used for traditional Nix SHA-256 hashes.
preferred. For example: For example:
```nix ```nix
cargoHash = "sha256-l1vL2ZdtDRxSGvP0X/l3nMw8+6WF67KPutJEzUROjg8="; cargoHash = "sha256-l1vL2ZdtDRxSGvP0X/l3nMw8+6WF67KPutJEzUROjg8=";
@ -64,18 +64,18 @@ Both types of hashes are permitted when contributing to nixpkgs. The
Cargo hash is obtained by inserting a fake checksum into the Cargo hash is obtained by inserting a fake checksum into the
expression and building the package once. The correct checksum can expression and building the package once. The correct checksum can
then be taken from the failed build. A fake hash can be used for then be taken from the failed build. A fake hash can be used for
`cargoSha256` as follows: `cargoHash` as follows:
```nix
cargoSha256 = lib.fakeSha256;
```
For `cargoHash` you can use:
```nix ```nix
cargoHash = lib.fakeHash; cargoHash = lib.fakeHash;
``` ```
For `cargoSha256` you can use:
```nix
cargoSha256 = lib.fakeSha256;
```
Per the instructions in the [Cargo Book](https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html) Per the instructions in the [Cargo Book](https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html)
best practices guide, Rust applications should always commit the `Cargo.lock` best practices guide, Rust applications should always commit the `Cargo.lock`
file in git to ensure a reproducible build. However, a few packages do not, and file in git to ensure a reproducible build. However, a few packages do not, and
@ -90,7 +90,7 @@ directory into a tar.gz archive.
The tarball with vendored dependencies contains a directory with the The tarball with vendored dependencies contains a directory with the
package's `name`, which is normally composed of `pname` and package's `name`, which is normally composed of `pname` and
`version`. This means that the vendored dependencies hash `version`. This means that the vendored dependencies hash
(`cargoSha256`/`cargoHash`) is dependent on the package name and (`cargoHash`/`cargoSha256`) is dependent on the package name and
version. The `cargoDepsName` attribute can be used to use another name version. The `cargoDepsName` attribute can be used to use another name
for the directory of vendored dependencies. For example, the hash can for the directory of vendored dependencies. For example, the hash can
be made invariant to the version by setting `cargoDepsName` to be made invariant to the version by setting `cargoDepsName` to
@ -115,7 +115,7 @@ rustPlatform.buildRustPackage rec {
### Importing a `Cargo.lock` file {#importing-a-cargo.lock-file} ### Importing a `Cargo.lock` file {#importing-a-cargo.lock-file}
Using `cargoSha256` or `cargoHash` is tedious when using Using a vendored hash (`cargoHash`/`cargoSha256`) is tedious when using
`buildRustPackage` within a project, since it requires that the hash `buildRustPackage` within a project, since it requires that the hash
is updated after every change to `Cargo.lock`. Therefore, is updated after every change to `Cargo.lock`. Therefore,
`buildRustPackage` also supports vendoring dependencies directly from `buildRustPackage` also supports vendoring dependencies directly from