doc: rust: document cargoLock.lockFileContents
This commit is contained in:
parent
9dafa439bc
commit
4ecb3e8795
|
@ -122,16 +122,38 @@ rustPlatform.buildRustPackage rec {
|
||||||
|
|
||||||
cargoLock = {
|
cargoLock = {
|
||||||
lockFile = ./Cargo.lock;
|
lockFile = ./Cargo.lock;
|
||||||
}
|
};
|
||||||
|
|
||||||
# ...
|
# ...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
This will retrieve the dependencies using fixed-output derivations from
|
This will retrieve the dependencies using fixed-output derivations from
|
||||||
the specified lockfile. Note that setting `cargoLock.lockFile` doesn't
|
the specified lockfile.
|
||||||
add a `Cargo.lock` to your `src`, and a `Cargo.lock` is still required
|
|
||||||
to build a rust package. A simple fix is to use:
|
Alternatively, `cargoLock.lockFileContents` can be set to a string of
|
||||||
|
the contents of a `Cargo.lock` file, for example if you need to
|
||||||
|
preprocess or generate the file as part of your build:
|
||||||
|
|
||||||
|
|
||||||
|
```nix
|
||||||
|
rustPlatform.buildRustPackage rec {
|
||||||
|
pname = "myproject";
|
||||||
|
version = "1.0.0";
|
||||||
|
|
||||||
|
cargoLock = let
|
||||||
|
fixupLockFile = path: /* ... */;
|
||||||
|
in {
|
||||||
|
lockFileContents = fixupLockFile ./Cargo.lock;
|
||||||
|
};
|
||||||
|
|
||||||
|
# ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that setting `cargoLock.lockFile` or `cargoLock.lockFileContents`
|
||||||
|
doesn't add a `Cargo.lock` to your `src`, and a `Cargo.lock` is still
|
||||||
|
required to build a rust package. A simple fix is to use:
|
||||||
|
|
||||||
```nix
|
```nix
|
||||||
postPatch = ''
|
postPatch = ''
|
||||||
|
|
Loading…
Reference in a new issue