]> git.lizzy.rs Git - rust.git/commitdiff
add note about passing cfg(debug_assertions)
authorrezural <69941255+rezural@users.noreply.github.com>
Sun, 20 Jun 2021 01:23:20 +0000 (11:23 +1000)
committerGitHub <noreply@github.com>
Sun, 20 Jun 2021 01:23:20 +0000 (11:23 +1000)
add note about passing cfg(debug_assertions) to rustc on build. The server will not spin without this arcane hack

docs/dev/debugging.md

index 5876e71bcab1d446bed35b3707252405260f38e5..48caec1d8fa6ee1b5c45e384be48e661c3efe6e4 100644 (file)
@@ -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).