diff options
| author | bors <bors@rust-lang.org> | 2024-06-23 17:11:16 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2024-06-23 17:11:16 +0000 |
| commit | 33422e72c8a66bdb5ee21246a948a1a02ca91674 (patch) | |
| tree | c1c0a241bdaef5d0ad75b0b556fe5f168bc7377b /src/tools/rust-analyzer/docs | |
| parent | aabbf84b45a5e7b868c33e959d7e5cc985097d19 (diff) | |
| parent | 70e9582f4c076a6b22ba4844f075762a1ed2296b (diff) | |
| download | rust-33422e72c8a66bdb5ee21246a948a1a02ca91674.tar.gz rust-33422e72c8a66bdb5ee21246a948a1a02ca91674.zip | |
Auto merge of #126865 - lnicola:sync-from-ra, r=lnicola
Subtree update of `rust-analyzer` r? `@ghost`
Diffstat (limited to 'src/tools/rust-analyzer/docs')
| -rw-r--r-- | src/tools/rust-analyzer/docs/dev/README.md | 2 | ||||
| -rw-r--r-- | src/tools/rust-analyzer/docs/dev/lsp-extensions.md | 15 | ||||
| -rw-r--r-- | src/tools/rust-analyzer/docs/user/generated_config.adoc | 2 | ||||
| -rw-r--r-- | src/tools/rust-analyzer/docs/user/manual.adoc | 4 |
4 files changed, 17 insertions, 6 deletions
diff --git a/src/tools/rust-analyzer/docs/dev/README.md b/src/tools/rust-analyzer/docs/dev/README.md index 8897f02e277..002b8ba2a66 100644 --- a/src/tools/rust-analyzer/docs/dev/README.md +++ b/src/tools/rust-analyzer/docs/dev/README.md @@ -145,7 +145,7 @@ To log all communication between the server and the client, there are two choice ``` env RA_LOG=lsp_server=debug code . ``` -* You can log on the client side, by enabling `"rust-analyzer.trace.server": "verbose"` workspace setting. +* You can log on the client side, by the `rust-analyzer: Toggle LSP Logs` command or enabling `"rust-analyzer.trace.server": "verbose"` workspace setting. These logs are shown in a separate tab in the output and could be used with LSP inspector. Kudos to [@DJMcNab](https://github.com/DJMcNab) for setting this awesome infra up! diff --git a/src/tools/rust-analyzer/docs/dev/lsp-extensions.md b/src/tools/rust-analyzer/docs/dev/lsp-extensions.md index 1c91e856e72..695fec7e8e0 100644 --- a/src/tools/rust-analyzer/docs/dev/lsp-extensions.md +++ b/src/tools/rust-analyzer/docs/dev/lsp-extensions.md @@ -1,5 +1,5 @@ <!--- -lsp/ext.rs hash: 1babf76a3c2cef3b +lsp/ext.rs hash: 8e6e340f2899b5e9 If you need to change the above hash to make the test pass, please check if you need to adjust this doc as well and ping this issue: @@ -372,7 +372,7 @@ interface Runnable { } ``` -rust-analyzer supports only one `kind`, `"cargo"`. The `args` for `"cargo"` look like this: +rust-analyzer supports two `kind`s of runnables, `"cargo"` and `"shell"`. The `args` for `"cargo"` look like this: ```typescript { @@ -386,6 +386,17 @@ rust-analyzer supports only one `kind`, `"cargo"`. The `args` for `"cargo"` look } ``` +The args for `"shell"` look like this: + +```typescript +{ + kind: string; + program: string; + args: string[]; + cwd: string; +} +``` + ## Test explorer **Experimental Client Capability:** `{ "testExplorer": boolean }` diff --git a/src/tools/rust-analyzer/docs/user/generated_config.adoc b/src/tools/rust-analyzer/docs/user/generated_config.adoc index 8993a46d2b8..14aae91741e 100644 --- a/src/tools/rust-analyzer/docs/user/generated_config.adoc +++ b/src/tools/rust-analyzer/docs/user/generated_config.adoc @@ -19,7 +19,7 @@ Term search fuel in "units of work" for assists (Defaults to 400). -- Warm up caches on project load. -- -[[rust-analyzer.cachePriming.numThreads]]rust-analyzer.cachePriming.numThreads (default: `0`):: +[[rust-analyzer.cachePriming.numThreads]]rust-analyzer.cachePriming.numThreads (default: `"physical"`):: + -- How many worker threads to handle priming caches. The default `0` means to pick automatically. diff --git a/src/tools/rust-analyzer/docs/user/manual.adoc b/src/tools/rust-analyzer/docs/user/manual.adoc index 8e6c53d0c5a..e1c1c54ec41 100644 --- a/src/tools/rust-analyzer/docs/user/manual.adoc +++ b/src/tools/rust-analyzer/docs/user/manual.adoc @@ -21,7 +21,7 @@ The LSP allows various code editors, like VS Code, Emacs or Vim, to implement se To improve this document, send a pull request: + https://github.com/rust-lang/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc] -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. +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 xtask codegen` to create these and then `asciidoctor manual.adoc` to create an HTML copy. ==== 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. @@ -591,7 +591,7 @@ The next thing to check would be panic messages in rust-analyzer's log. Log messages are printed to stderr, in VS Code you can see them in the `Output > Rust Analyzer Language Server` tab of the panel. To see more logs, set the `RA_LOG=info` environment variable, this can be done either by setting the environment variable manually or by using `rust-analyzer.server.extraEnv`, note that both of these approaches require the server to be restarted. -To fully capture LSP messages between the editor and the server, set `"rust-analyzer.trace.server": "verbose"` config and check +To fully capture LSP messages between the editor and the server, run the `rust-analyzer: Toggle LSP Logs` command and check `Output > Rust Analyzer Language Server Trace`. The root cause for many "`nothing works`" problems is that rust-analyzer fails to understand the project structure. |
