summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorLangston Barrett <langston.barrett@gmail.com>2023-03-16 17:36:38 -0400
committerMichael Goulet <michael@errs.io>2023-03-16 18:40:40 -0700
commit0eb0d25f26ed340cdfc9b24ddb6d173f7a7503bd (patch)
treee26a4a7e5230e28b858fe87e866ff4333f4be3ac /src/doc/rustc-dev-guide
parent7dedcf9ade17e5ae6a4aa3ea737decc22002b105 (diff)
downloadrust-0eb0d25f26ed340cdfc9b24ddb6d173f7a7503bd.tar.gz
rust-0eb0d25f26ed340cdfc9b24ddb6d173f7a7503bd.zip
Mention debug assertions
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/fuzzing.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/fuzzing.md b/src/doc/rustc-dev-guide/src/fuzzing.md
index 1c6dcfe3a21..f687fbc92d7 100644
--- a/src/doc/rustc-dev-guide/src/fuzzing.md
+++ b/src/doc/rustc-dev-guide/src/fuzzing.md
@@ -120,6 +120,16 @@ target-cpu=native` or even PGO/BOLT to squeeze out a few more executions per
 second. Of course, it's best to try multiple build configurations and see
 what actually results in superior throughput.
 
+You may want to build rustc from source with debug assertions to find
+additional bugs, though this is a trade-off: it can slow down fuzzing by
+requiring extra work for every execution. To enable debug assertions, add this
+to `config.toml` when compiling rustc:
+
+```toml
+[rust]
+debug-assertions = true
+```
+
 ## Existing projects
 
 - [fuzz-rustc][fuzz-rustc] demonstrates how to fuzz rustc with libfuzzer