doc/languages-frameworks/rust: example for disabling tests (#198705)

NixOS · Oct 31, 2022 · b37df78 · b37df78
1 parent 78723ab
commit b37df78
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/doc/languages-frameworks/rust.section.md b/doc/languages-frameworks/rust.section.md
@@ -319,6 +319,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.
 
+This can be achived with `--skip` in `checkFlags`:
+
+```nix
+rustPlatform.buildRustPackage {
+ /* ... */
+ checkFlags = [
+ # reason for disabling test
+ "--skip=example::tests:example_test"
+ ];
+}
+```
+
 #### Setting `test-threads` {#setting-test-threads}
 
 `buildRustPackage` will use parallel test threads by default,