about summary refs log tree commit diff
path: root/docs/dev/debugging.md
diff options
context:
space:
mode:
authorrezural <69941255+rezural@users.noreply.github.com>2021-06-20 11:23:20 +1000
committerGitHub <noreply@github.com>2021-06-20 11:23:20 +1000
commit530ee4ff8a63cce0a74117a8ae56a1435e5c634f (patch)
treecf7fb7c5ec6dbcdcdad81083f5757e036ee3cae0 /docs/dev/debugging.md
parent9d60d75e1400ba82ae8d41496d8a0fb9a8edec0c (diff)
downloadrust-530ee4ff8a63cce0a74117a8ae56a1435e5c634f.tar.gz
rust-530ee4ff8a63cce0a74117a8ae56a1435e5c634f.zip
add note about passing cfg(debug_assertions)
add note about passing cfg(debug_assertions) to rustc on build. The server will not spin without this arcane hack
Diffstat (limited to 'docs/dev/debugging.md')
-rw-r--r--docs/dev/debugging.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/dev/debugging.md b/docs/dev/debugging.md
index 5876e71bcab..48caec1d8fa 100644
--- a/docs/dev/debugging.md
+++ b/docs/dev/debugging.md
@@ -65,6 +65,11 @@ If you need to debug the server from the very beginning, including its initializ
     }
 ```
 
+However for this to work, you will need to enable debug_assertions in your build
+```rust
+RUSTFLAGS='--cfg debug_assertions' cargo build --release
+```
+
 ## Demo
 
 - [Debugging TypeScript VScode extension](https://www.youtube.com/watch?v=T-hvpK6s4wM).