aboutsummaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/README.md4
-rw-r--r--docs/dev/debugging.md8
-rw-r--r--docs/dev/style.md2
3 files changed, 13 insertions, 1 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
index 6a6ba1443..6bce38e56 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -43,6 +43,10 @@ https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0
43 while unactionable ones are effectively wont-fix. Each triaged issue should have one of these labels. 43 while unactionable ones are effectively wont-fix. Each triaged issue should have one of these labels.
44* [fun](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3Afun) 44* [fun](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%3Afun)
45 is for cool, but probably hard stuff. 45 is for cool, but probably hard stuff.
46* [Design](https://github.com/rust-analyzer/rust-analyzer/issues?q=is%3Aopen+is%3Aissue+label%Design)
47 is for moderate/large scale architecture discussion.
48 Also a kind of fun.
49 These issues should generally include a link to a Zulip discussion thread.
46 50
47# CI 51# CI
48 52
diff --git a/docs/dev/debugging.md b/docs/dev/debugging.md
index 8c48fd5a1..cc7a790ff 100644
--- a/docs/dev/debugging.md
+++ b/docs/dev/debugging.md
@@ -57,6 +57,14 @@ To apply changes to an already running debug process, press <kbd>Ctrl+Shift+P</k
57 57
58- Go back to the `[Extension Development Host]` instance and hover over a Rust variable and your breakpoint should hit. 58- Go back to the `[Extension Development Host]` instance and hover over a Rust variable and your breakpoint should hit.
59 59
60If you need to debug the server from the very beginning, including its initialization code, you can use the `--wait-dbg` command line argument or `RA_WAIT_DBG` environment variable. The server will spin at the beginning of the `try_main` function (see `crates\rust-analyzer\src\bin\main.rs`)
61```rust
62 let mut d = 4;
63 while d == 4 { // set a breakpoint here and change the value
64 d = 4;
65 }
66```
67
60## Demo 68## Demo
61 69
62- [Debugging TypeScript VScode extension](https://www.youtube.com/watch?v=T-hvpK6s4wM). 70- [Debugging TypeScript VScode extension](https://www.youtube.com/watch?v=T-hvpK6s4wM).
diff --git a/docs/dev/style.md b/docs/dev/style.md
index 6dc6868c2..0c5e2ad33 100644
--- a/docs/dev/style.md
+++ b/docs/dev/style.md
@@ -232,7 +232,7 @@ if idx >= len {
232## Assertions 232## Assertions
233 233
234Assert liberally. 234Assert liberally.
235Prefer `stdx::assert_never!` to standard `assert!`. 235Prefer `stdx::never!` to standard `assert!`.
236 236
237## Getters & Setters 237## Getters & Setters
238 238