From 530ee4ff8a63cce0a74117a8ae56a1435e5c634f Mon Sep 17 00:00:00 2001
From: rezural <69941255+rezural@users.noreply.github.com>
Date: Sun, 20 Jun 2021 11:23:20 +1000
Subject: 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
---
 docs/dev/debugging.md | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'docs')

diff --git a/docs/dev/debugging.md b/docs/dev/debugging.md
index 5876e71bc..48caec1d8 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).
-- 
cgit v1.2.3