diff options
Diffstat (limited to 'docs/user/manual.adoc')
-rw-r--r-- | docs/user/manual.adoc | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index 75445a02e..990b11859 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc | |||
@@ -18,6 +18,9 @@ The LSP allows various code editors, like VS Code, Emacs or Vim, to implement se | |||
18 | [.lead] | 18 | [.lead] |
19 | To improve this document, send a pull request: + | 19 | 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] | 20 | https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/manual.adoc[https://github.com/rust-analyzer/.../manual.adoc] |
21 | |||
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 xtask codegen` to create these and then `asciidoctor manual.adoc` to create an HTML copy. | ||
23 | |||
21 | ==== | 24 | ==== |
22 | 25 | ||
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. | 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. |
@@ -112,7 +115,7 @@ $ code --install-extension /path/to/rust-analyzer.vsix | |||
112 | Copy the `rust-analyzer-{platform}` binary anywhere, then add the path to your settings.json, for example: | 115 | Copy the `rust-analyzer-{platform}` binary anywhere, then add the path to your settings.json, for example: |
113 | [source,json] | 116 | [source,json] |
114 | ---- | 117 | ---- |
115 | { "rust-analyzer.serverPath": "~/.local/bin/rust-analyzer-linux" } | 118 | { "rust-analyzer.server.path": "~/.local/bin/rust-analyzer-linux" } |
116 | ---- | 119 | ---- |
117 | 120 | ||
118 | ==== Building From Source | 121 | ==== Building From Source |
@@ -216,7 +219,7 @@ The are several LSP client implementations for vim or neovim: | |||
216 | https://github.com/fannheyward/coc-rust-analyzer[coc-rust-analyzer], | 219 | https://github.com/fannheyward/coc-rust-analyzer[coc-rust-analyzer], |
217 | this extension implements _most_ of the features supported in the VSCode extension: | 220 | this extension implements _most_ of the features supported in the VSCode extension: |
218 | * automatically install and upgrade stable/nightly releases | 221 | * automatically install and upgrade stable/nightly releases |
219 | * same configurations as VSCode extension, `rust-analyzer.serverPath`, `rust-analyzer.cargo.features` etc. | 222 | * same configurations as VSCode extension, `rust-analyzer.server.path`, `rust-analyzer.cargo.features` etc. |
220 | * same commands too, `rust-analyzer.analyzerStatus`, `rust-analyzer.ssr` etc. | 223 | * same commands too, `rust-analyzer.analyzerStatus`, `rust-analyzer.ssr` etc. |
221 | * inlay hints for variables and method chaining, _Neovim Only_ | 224 | * inlay hints for variables and method chaining, _Neovim Only_ |
222 | * semantic highlighting is not implemented yet | 225 | * semantic highlighting is not implemented yet |