add documentation

This commit is contained in:
Aaron Janse 2020-10-17 00:48:07 -07:00
parent 7c92361028
commit 2bccf2e554

View file

@ -123,6 +123,9 @@ build the Rust tools and standard library crates separately so there is no
reason not to take the `stdenv.hostPlatform.rustc`-modifying approach, and the
ad-hoc escape hatch to `buildRustPackage` can be removed.
Note that currently custom targets aren't compiled with `std`, so `cargo test`
will fail. This can be ignored by adding `doCheck = false;` to your derivation.
### Running package tests
When using `buildRustPackage`, the `checkPhase` is enabled by default and runs