diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 4 | ||||
-rw-r--r-- | docs/dev/debugging.md | 8 | ||||
-rw-r--r-- | docs/dev/style.md | 2 | ||||
-rw-r--r-- | docs/user/generated_config.adoc | 8 |
4 files changed, 17 insertions, 5 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 | ||
60 | If 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 | ||
234 | Assert liberally. | 234 | Assert liberally. |
235 | Prefer `stdx::assert_never!` to standard `assert!`. | 235 | Prefer `stdx::never!` to standard `assert!`. |
236 | 236 | ||
237 | ## Getters & Setters | 237 | ## Getters & Setters |
238 | 238 | ||
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 2f681b01a..1974082da 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc | |||
@@ -7,7 +7,7 @@ | |||
7 | [[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`):: | 7 | [[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`):: |
8 | Automatically refresh project info via `cargo metadata` on `Cargo.toml` changes. | 8 | Automatically refresh project info via `cargo metadata` on `Cargo.toml` changes. |
9 | [[rust-analyzer.cargo.allFeatures]]rust-analyzer.cargo.allFeatures (default: `false`):: | 9 | [[rust-analyzer.cargo.allFeatures]]rust-analyzer.cargo.allFeatures (default: `false`):: |
10 | Activate all available features. | 10 | Activate all available features (`--all-features`). |
11 | [[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`):: | 11 | [[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`):: |
12 | List of features to activate. | 12 | List of features to activate. |
13 | [[rust-analyzer.cargo.loadOutDirsFromCheck]]rust-analyzer.cargo.loadOutDirsFromCheck (default: `false`):: | 13 | [[rust-analyzer.cargo.loadOutDirsFromCheck]]rust-analyzer.cargo.loadOutDirsFromCheck (default: `false`):: |
@@ -21,9 +21,9 @@ | |||
21 | [[rust-analyzer.checkOnSave.enable]]rust-analyzer.checkOnSave.enable (default: `true`):: | 21 | [[rust-analyzer.checkOnSave.enable]]rust-analyzer.checkOnSave.enable (default: `true`):: |
22 | Run specified `cargo check` command for diagnostics on save. | 22 | Run specified `cargo check` command for diagnostics on save. |
23 | [[rust-analyzer.checkOnSave.allFeatures]]rust-analyzer.checkOnSave.allFeatures (default: `null`):: | 23 | [[rust-analyzer.checkOnSave.allFeatures]]rust-analyzer.checkOnSave.allFeatures (default: `null`):: |
24 | Check with all features (will be passed as `--all-features`). Defaults to `#rust-analyzer.cargo.allFeatures#`. | 24 | Check with all features (`--all-features`). Defaults to `#rust-analyzer.cargo.allFeatures#`. |
25 | [[rust-analyzer.checkOnSave.allTargets]]rust-analyzer.checkOnSave.allTargets (default: `true`):: | 25 | [[rust-analyzer.checkOnSave.allTargets]]rust-analyzer.checkOnSave.allTargets (default: `true`):: |
26 | Check all targets and tests (will be passed as `--all-targets`). | 26 | Check all targets and tests (`--all-targets`). |
27 | [[rust-analyzer.checkOnSave.command]]rust-analyzer.checkOnSave.command (default: `"check"`):: | 27 | [[rust-analyzer.checkOnSave.command]]rust-analyzer.checkOnSave.command (default: `"check"`):: |
28 | Cargo command to use for `cargo check`. | 28 | Cargo command to use for `cargo check`. |
29 | [[rust-analyzer.checkOnSave.noDefaultFeatures]]rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`):: | 29 | [[rust-analyzer.checkOnSave.noDefaultFeatures]]rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`):: |
@@ -91,7 +91,7 @@ | |||
91 | [[rust-analyzer.linkedProjects]]rust-analyzer.linkedProjects (default: `[]`):: | 91 | [[rust-analyzer.linkedProjects]]rust-analyzer.linkedProjects (default: `[]`):: |
92 | Disable project auto-discovery in favor of explicitly specified set of projects.\n\nElements must be paths pointing to `Cargo.toml`, `rust-project.json`, or JSON objects in `rust-project.json` format. | 92 | Disable project auto-discovery in favor of explicitly specified set of projects.\n\nElements must be paths pointing to `Cargo.toml`, `rust-project.json`, or JSON objects in `rust-project.json` format. |
93 | [[rust-analyzer.lruCapacity]]rust-analyzer.lruCapacity (default: `null`):: | 93 | [[rust-analyzer.lruCapacity]]rust-analyzer.lruCapacity (default: `null`):: |
94 | Number of syntax trees rust-analyzer keeps in memory. Defaults to 128. | 94 | Number of syntax trees rust-analyzer keeps in memory. Defaults to 128. |
95 | [[rust-analyzer.notifications.cargoTomlNotFound]]rust-analyzer.notifications.cargoTomlNotFound (default: `true`):: | 95 | [[rust-analyzer.notifications.cargoTomlNotFound]]rust-analyzer.notifications.cargoTomlNotFound (default: `true`):: |
96 | Whether to show `can't find Cargo.toml` error message. | 96 | Whether to show `can't find Cargo.toml` error message. |
97 | [[rust-analyzer.procMacro.enable]]rust-analyzer.procMacro.enable (default: `false`):: | 97 | [[rust-analyzer.procMacro.enable]]rust-analyzer.procMacro.enable (default: `false`):: |