diff options
Diffstat (limited to 'docs/user/manual.adoc')
-rw-r--r-- | docs/user/manual.adoc | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index 46e7bd091..b9d907a4a 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc | |||
@@ -116,6 +116,7 @@ Here are some useful self-diagnostic commands: | |||
116 | * **Rust Analyzer: Show RA Version** shows the version of `rust-analyzer` binary. | 116 | * **Rust Analyzer: Show RA Version** shows the version of `rust-analyzer` binary. |
117 | * **Rust Analyzer: Status** prints some statistics about the server, and dependency information for the current file. | 117 | * **Rust Analyzer: Status** prints some statistics about the server, and dependency information for the current file. |
118 | * To enable server-side logging, run with `env RA_LOG=info` and see `Output > Rust Analyzer Language Server` in VS Code's panel. | 118 | * To enable server-side logging, run with `env RA_LOG=info` and see `Output > Rust Analyzer Language Server` in VS Code's panel. |
119 | * To log project loading (sysroot & `cargo metadata`), set `RA_LOG=project_model=debug`. | ||
119 | * To log all LSP requests, add `"rust-analyzer.trace.server": "verbose"` to the settings and look for `Rust Analyzer Language Server Trace` in the panel. | 120 | * To log all LSP requests, add `"rust-analyzer.trace.server": "verbose"` to the settings and look for `Rust Analyzer Language Server Trace` in the panel. |
120 | * To enable client-side logging, add `"rust-analyzer.trace.extension": true` to the settings and open `Output > Rust Analyzer Client` in the panel. | 121 | * To enable client-side logging, add `"rust-analyzer.trace.extension": true` to the settings and open `Output > Rust Analyzer Client` in the panel. |
121 | 122 | ||
@@ -260,16 +261,7 @@ If you get an error saying `No such file or directory: 'rust-analyzer'`, see the | |||
260 | 261 | ||
261 | === GNOME Builder | 262 | === GNOME Builder |
262 | 263 | ||
263 | Prerequisites: You have installed the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>>. | 264 | GNOME Builder 3.37.1 and newer has native `rust-analyzer` support. If the LSP binary is not available, GNOME Builder can install it when opening a Rust file. |
264 | |||
265 | Gnome Builder currently has support for RLS, and there's no way to configure the language server executable. A future version might support `rust-analyzer` out of the box. | ||
266 | |||
267 | 1. Rename, symlink or copy the `rust-analyzer` binary to `rls` and place it somewhere Builder can find (in `PATH`, or under `~/.cargo/bin`). | ||
268 | 2. Enable the Rust Builder plugin. | ||
269 | |||
270 | ==== GNOME Builder (Nightly) | ||
271 | |||
272 | https://nightly.gnome.org/repo/appstream/org.gnome.Builder.flatpakref[GNOME Builder (Nightly)] has now native support for `rust-analyzer` out of the box. If the `rust-analyzer` binary is not available, GNOME Builder can install it when opening a Rust source file. | ||
273 | 265 | ||
274 | == Non-Cargo Based Projects | 266 | == Non-Cargo Based Projects |
275 | 267 | ||
@@ -295,6 +287,9 @@ interface JsonProject { | |||
295 | } | 287 | } |
296 | 288 | ||
297 | interface Crate { | 289 | interface Crate { |
290 | /// Optional crate name used for display purposes, without affecting semantics. | ||
291 | /// See the `deps` key for semantically-significant crate names. | ||
292 | display_name?: string; | ||
298 | /// Path to the root module of the crate. | 293 | /// Path to the root module of the crate. |
299 | root_module: string; | 294 | root_module: string; |
300 | /// Edition of the crate. | 295 | /// Edition of the crate. |
@@ -371,6 +366,13 @@ Cursor position or selection is signified by `┃` character. | |||
371 | 366 | ||
372 | include::./generated_assists.adoc[] | 367 | include::./generated_assists.adoc[] |
373 | 368 | ||
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 | |||
374 | == Editor Features | 376 | == Editor Features |
375 | === VS Code | 377 | === VS Code |
376 | 378 | ||