Skip to content

Commit edf46a1

Browse files
bors[bot]flodieboldstanciuadrian
authored
Merge #6325 #6327
6325: Add generated diagnostic docs to the manual r=matklad a=flodiebold It seemed that we're not actually including the generated diagnostic docs anywhere yet? So I added something to the manual. This is completely untested though. 6327: Update debugging.md r=matklad a=stanciuadrian `on_task` is no longer there. I have used `on_request` instead. Co-authored-by: Florian Diebold <[email protected]> Co-authored-by: Adrian Stanciu <[email protected]>
3 parents 3d34959 + b59a0db + 5f5b1ff commit edf46a1

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/dev/debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ To apply changes to an already running debug process, press <kbd>Ctrl+Shift+P</k
5353

5454
- A list of running processes should appear. Select the `rust-analyzer` from this repo.
5555

56-
- Navigate to `crates/rust-analyzer/src/main_loop.rs` and add a breakpoint to the `on_task` function.
56+
- Navigate to `crates/rust-analyzer/src/main_loop.rs` and add a breakpoint to the `on_request` function.
5757

5858
- Go back to the `[Extension Development Host]` instance and hover over a Rust variable and your breakpoint should hit.
5959

docs/user/manual.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -366,6 +366,13 @@ Cursor position or selection is signified by `┃` character.
366366

367367
include::./generated_assists.adoc[]
368368

369+
== Diagnostics
370+
371+
While most errors and warnings provided by rust-analyzer come from the `cargo check` integration, there's a growing number of diagnostics implemented using rust-analyzer's own analysis.
372+
These diagnostics don't respect `#[allow]` or `#[deny]` attributes yet, but can be turned off using the `rust-analyzer.diagnostics.enable`, `rust-analyzer.diagnostics.enableExperimental` or `rust-analyzer.diagnostics.disabled` settings.
373+
374+
include::./generated_diagnostic.adoc[]
375+
369376
== Editor Features
370377
=== VS Code
371378

0 commit comments

Comments
 (0)