buildRustPackage: add documentation on how to create cargo.lock patches

This commit is contained in:
Jörg Thalheim 2020-06-05 08:10:53 +01:00
parent fb6c3cee64
commit f0396574ab
No known key found for this signature in database
GPG key ID: 003F2096411B5F92
2 changed files with 19 additions and 0 deletions

View file

@ -75,6 +75,24 @@ pkgs.rustPlatform.buildRustPackage {
}
```
### Building a crate with an absent or out-of-date Cargo.lock file
`buildRustPackage` needs a `Cargo.lock` file to get all dependencies in the
source code in a reproducible way. If it is missing or out-of-date one can use
the `cargoPatches` attribute to update or add it.
```
{ lib, rustPlatform, fetchFromGitHub }:
rustPlatform.buildRustPackage rec {
(...)
cargoPatches = [
# a patch file to add/update Cargo.lock in the source code
./add-Cargo.lock.patch
];
}
```
## Compiling Rust crates using Nix instead of Cargo
### Simple operation

View file

@ -130,6 +130,7 @@ stdenv.mkDerivation (args // {
# give a friendlier error msg.
if ! [ -e $srcLockfile ]; then
echo "ERROR: Missing Cargo.lock from src. Expected to find it at: $srcLockfile"
echo "Hint: You can use the cargoPatches attribute to add a Cargo.lock manually to the build."
exit 1
fi