diff options
Diffstat (limited to 'docs/user')
-rw-r--r-- | docs/user/generated_config.adoc | 2 | ||||
-rw-r--r-- | docs/user/manual.adoc | 77 |
2 files changed, 64 insertions, 15 deletions
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index ff4fb064e..e2d74e164 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc | |||
@@ -1,4 +1,4 @@ | |||
1 | [[rust-analyzer.assist.importMergeBehavior]]rust-analyzer.assist.importMergeBehavior (default: `"full"`):: | 1 | [[rust-analyzer.assist.importMergeBehavior]]rust-analyzer.assist.importMergeBehavior (default: `"crate"`):: |
2 | + | 2 | + |
3 | -- | 3 | -- |
4 | The strategy to use when inserting new imports or merging imports. | 4 | The strategy to use when inserting new imports or merging imports. |
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index 58722aaa3..f96c09a79 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc | |||
@@ -6,8 +6,6 @@ | |||
6 | :source-highlighter: rouge | 6 | :source-highlighter: rouge |
7 | :experimental: | 7 | :experimental: |
8 | 8 | ||
9 | // Master copy of this document lives in the https://github.com/rust-analyzer/rust-analyzer repository | ||
10 | |||
11 | At its core, rust-analyzer is a *library* for semantic analysis of Rust code as it changes over time. | 9 | At its core, rust-analyzer is a *library* for semantic analysis of Rust code as it changes over time. |
12 | This manual focuses on a specific usage of the library -- running it as part of a server that implements the | 10 | This manual focuses on a specific usage of the library -- running it as part of a server that implements the |
13 | https://microsoft.github.io/language-server-protocol/[Language Server Protocol] (LSP). | 11 | https://microsoft.github.io/language-server-protocol/[Language Server Protocol] (LSP). |
@@ -20,7 +18,6 @@ To improve this document, send a pull request: + | |||
20 | https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc] | 18 | https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc] |
21 | 19 | ||
22 | The manual is written in https://asciidoc.org[AsciiDoc] and includes some extra files which are generated from the source code. Run `cargo test` and `cargo test -p xtask` to create these and then `asciidoctor manual.adoc` to create an HTML copy. | 20 | The manual is written in https://asciidoc.org[AsciiDoc] and includes some extra files which are generated from the source code. Run `cargo test` and `cargo test -p xtask` to create these and then `asciidoctor manual.adoc` to create an HTML copy. |
23 | |||
24 | ==== | 21 | ==== |
25 | 22 | ||
26 | If you have questions about using rust-analyzer, please ask them in the https://users.rust-lang.org/c/ide/14["`IDEs and Editors`"] topic of Rust users forum. | 23 | If you have questions about using rust-analyzer, please ask them in the https://users.rust-lang.org/c/ide/14["`IDEs and Editors`"] topic of Rust users forum. |
@@ -139,17 +136,6 @@ If you're not using Code, you can compile and install only the LSP server: | |||
139 | $ cargo xtask install --server | 136 | $ cargo xtask install --server |
140 | ---- | 137 | ---- |
141 | 138 | ||
142 | ==== Troubleshooting | ||
143 | |||
144 | Here are some useful self-diagnostic commands: | ||
145 | |||
146 | * **Rust Analyzer: Show RA Version** shows the version of `rust-analyzer` binary. | ||
147 | * **Rust Analyzer: Status** prints some statistics about the server, and dependency information for the current file. | ||
148 | * To enable server-side logging, run with `env RA_LOG=info` and see `Output > Rust Analyzer Language Server` in VS Code's panel. | ||
149 | * To log project loading (sysroot & `cargo metadata`), set `RA_LOG=project_model=debug`. | ||
150 | * 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. | ||
151 | * To enable client-side logging, add `"rust-analyzer.trace.extension": true` to the settings and open `Output > Rust Analyzer Client` in the panel. | ||
152 | |||
153 | === rust-analyzer Language Server Binary | 139 | === rust-analyzer Language Server Binary |
154 | 140 | ||
155 | Other editors generally require the `rust-analyzer` binary to be in `$PATH`. | 141 | Other editors generally require the `rust-analyzer` binary to be in `$PATH`. |
@@ -385,6 +371,68 @@ If available in PATH or in some standard location, `rust-analyzer` is detected a | |||
385 | If `rust-analyzer` is not detected, Corrosion will prompt you for configuration of your Rust toolchain and language server with a link to the __Window > Preferences > Rust__ preference page; from here a button allows to download and configure `rust-analyzer`, but you can also reference another installation. | 371 | If `rust-analyzer` is not detected, Corrosion will prompt you for configuration of your Rust toolchain and language server with a link to the __Window > Preferences > Rust__ preference page; from here a button allows to download and configure `rust-analyzer`, but you can also reference another installation. |
386 | You'll need to close and reopen all .rs and Cargo files, or to restart the IDE, for this change to take effect. | 372 | You'll need to close and reopen all .rs and Cargo files, or to restart the IDE, for this change to take effect. |
387 | 373 | ||
374 | === Kate Text Editor | ||
375 | |||
376 | Support for the language server protocol is built into Kate through the LSP plugin, which is included by default. | ||
377 | It is preconfigured to use Rls for rust sources, but allows you to use rust-analyzer through a simple settings change. | ||
378 | In the LSP Client settings of Kate, copy the content of the third tab "default parameters" to the second tab "server configuration". | ||
379 | Then in the configuration replace: | ||
380 | [source,json] | ||
381 | ---- | ||
382 | "rust": { | ||
383 | "command": ["rls"], | ||
384 | "rootIndicationFileNames": ["Cargo.lock", "Cargo.toml"], | ||
385 | "url": "https://github.com/rust-lang/rls", | ||
386 | "highlightingModeRegex": "^Rust$" | ||
387 | }, | ||
388 | ---- | ||
389 | With | ||
390 | [source,json] | ||
391 | ---- | ||
392 | "rust": { | ||
393 | "command": ["rust-analyzer"], | ||
394 | "rootIndicationFileNames": ["Cargo.lock", "Cargo.toml"], | ||
395 | "url": "https://github.com/rust-analyzer/rust-analyzer", | ||
396 | "highlightingModeRegex": "^Rust$" | ||
397 | }, | ||
398 | ---- | ||
399 | Then click on apply, and restart the LSP server for your rust project. | ||
400 | |||
401 | == Troubleshooting | ||
402 | |||
403 | Start with looking at the rust-analyzer version. | ||
404 | Try **Rust Analyzer: Show RA Version** in VS Code and `rust-analyzer --version` in the command line. | ||
405 | If the date is more than a week ago, it's better to update rust-analyzer version. | ||
406 | |||
407 | The next thing to check would be panic messages in rust-analyzer's log. | ||
408 | Log messages are printed to stderr, in VS Code you can see then in the `Output > Rust Analyzer Language Server` tab of the panel. | ||
409 | To see more logs, set `RA_LOG=info` environmental variable. | ||
410 | |||
411 | To fully capture LSP messages between the editor and the server, set `"rust-analyzer.trace.server": "verbose"` config and check | ||
412 | `Output > Rust Analyzer Language Server Trace`. | ||
413 | |||
414 | The root cause for many "`nothing works`" problems is that rust-analyzer fails to understand the project structure. | ||
415 | To debug that, first note the `rust-analyzer` section in the status bar. | ||
416 | If it has an error icon and red, that's the problem (hover will have somewhat helpful error message). | ||
417 | **Rust Analyzer: Status** prints dependency information for the current file. | ||
418 | Finally, `RA_LOG=project_model=debug` enables verbose logs during project loading. | ||
419 | |||
420 | If rust-analyzer outright crashes, try running `rust-analyzer analysis-stats /path/to/project/directory/` on the command line. | ||
421 | This command type checks the whole project in batch mode bypassing LSP machinery. | ||
422 | |||
423 | When filing issues, it is useful (but not necessary) to try to minimize examples. | ||
424 | An ideal bug reproduction looks like this: | ||
425 | |||
426 | ```bash | ||
427 | $ git clone https://github.com/username/repo.git && cd repo && git switch --detach commit-hash | ||
428 | $ rust-analyzer --version | ||
429 | rust-analyzer dd12184e4 2021-05-08 dev | ||
430 | $ rust-analyzer analysis-stats . | ||
431 | 💀 💀 💀 | ||
432 | ``` | ||
433 | |||
434 | It is especially useful when the `repo` doesn't use external crates or the standard library. | ||
435 | |||
388 | == Configuration | 436 | == Configuration |
389 | 437 | ||
390 | **Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/rust-analyzer/src/config.rs[config.rs] | 438 | **Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/rust-analyzer/src/config.rs[config.rs] |
@@ -541,6 +589,7 @@ Here is a **non-exhaustive** list of ways to make rust-analyzer execute arbitrar | |||
541 | 589 | ||
542 | * proc macros and build scripts are executed by default | 590 | * proc macros and build scripts are executed by default |
543 | * `.cargo/config` can override `rustc` with an arbitrary executable | 591 | * `.cargo/config` can override `rustc` with an arbitrary executable |
592 | * `rust-toolchain.toml` can override `rustc` with an arbitrary executable | ||
544 | * VS Code plugin reads configuration from project directory, and that can be used to override paths to various executables, like `rustfmt` or `rust-analyzer` itself. | 593 | * VS Code plugin reads configuration from project directory, and that can be used to override paths to various executables, like `rustfmt` or `rust-analyzer` itself. |
545 | * rust-analyzer's syntax trees library uses a lot of `unsafe` and hasn't been properly audited for memory safety. | 594 | * rust-analyzer's syntax trees library uses a lot of `unsafe` and hasn't been properly audited for memory safety. |
546 | 595 | ||