summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorzowoq <59103226+zowoq@users.noreply.github.com>2020-09-09 21:39:23 +1000
committerzowoq <59103226+zowoq@users.noreply.github.com>2020-09-24 07:19:58 +1000
commite4c71e6c6c7612f8e0d40ba5b79322f0883fa500 (patch)
treefcd0c2698c73b63ee54b15d8d561673d984d98e5 /doc
parenta4d05ec30c6636f8f1268efb8ddf6f9f8b7ca507 (diff)
buildRustPackage: support setting test-threads
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/rust.section.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/languages-frameworks/rust.section.md b/doc/languages-frameworks/rust.section.md
index 7f9d93216ed9..0e1d59e1a952 100644
--- a/doc/languages-frameworks/rust.section.md
+++ b/doc/languages-frameworks/rust.section.md
@@ -119,6 +119,18 @@ The above are just guidelines, and exceptions may be granted on a case-by-case b
However, please check if it's possible to disable a problematic subset of the
test suite and leave a comment explaining your reasoning.
+#### Setting `test-threads`
+
+`buildRustPackage` will use parallel test threads by default,
+sometimes it may be necessary to disable this so the tests run consecutively.
+
+```nix
+rustPlatform.buildRustPackage {
+ /* ... */
+ cargoParallelTestThreads = false;
+}
+```
+
### Building a package in `debug` mode
By default, `buildRustPackage` will use `release` mode for builds. If a package