diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 10 | ||||
-rw-r--r-- | docs/user/README.md | 9 |
2 files changed, 12 insertions, 7 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index 0a148ed32..0db3e731e 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -66,7 +66,7 @@ typescript) and Emacs (in elisp). The `docs` top-level directory contains both | |||
66 | developer and user documentation. | 66 | developer and user documentation. |
67 | 67 | ||
68 | We have some automation infra in Rust in the `crates/tool` package. It contains | 68 | We have some automation infra in Rust in the `crates/tool` package. It contains |
69 | stuff like formatting checking, code generation and powers `cargo install-code`. | 69 | stuff like formatting checking, code generation and powers `cargo install-ra`. |
70 | The latter syntax is achieved with the help of cargo aliases (see `.cargo` | 70 | The latter syntax is achieved with the help of cargo aliases (see `.cargo` |
71 | directory). | 71 | directory). |
72 | 72 | ||
@@ -84,7 +84,7 @@ However, launching a VS Code instance with locally build language server is | |||
84 | possible. There's even a VS Code task for this, so just <kbd>F5</kbd> should | 84 | possible. There's even a VS Code task for this, so just <kbd>F5</kbd> should |
85 | work (thanks, [@andrew-w-ross](https://github.com/andrew-w-ross)!). | 85 | work (thanks, [@andrew-w-ross](https://github.com/andrew-w-ross)!). |
86 | 86 | ||
87 | I often just install development version with `cargo jinstall-lsp` and | 87 | I often just install development version with `cargo install-ra --server --jemalloc` and |
88 | restart the host VS Code. | 88 | restart the host VS Code. |
89 | 89 | ||
90 | See [./debugging.md](./debugging.md) for how to attach to rust-analyzer with | 90 | See [./debugging.md](./debugging.md) for how to attach to rust-analyzer with |
@@ -110,12 +110,14 @@ ways: | |||
110 | 110 | ||
111 | 2. Run `npm test` from the command line. Although this is initiated from the | 111 | 2. Run `npm test` from the command line. Although this is initiated from the |
112 | command line it is not headless; it will also launch a temporary instance of | 112 | command line it is not headless; it will also launch a temporary instance of |
113 | VS Code. | 113 | VS Code. |
114 | 114 | ||
115 | Due to the requirements of running the tests inside VS Code they are **not run | 115 | Due to the requirements of running the tests inside VS Code they are **not run |
116 | on CI**. When making changes to the extension please ensure the tests are not | 116 | on CI**. When making changes to the extension please ensure the tests are not |
117 | broken locally before opening a Pull Request. | 117 | broken locally before opening a Pull Request. |
118 | 118 | ||
119 | To install **only** the VS Code extension, use `cargo install-ra --client-code`. | ||
120 | |||
119 | # Logging | 121 | # Logging |
120 | 122 | ||
121 | Logging is done by both rust-analyzer and VS Code, so it might be tricky to | 123 | Logging is done by both rust-analyzer and VS Code, so it might be tricky to |
@@ -151,7 +153,7 @@ There's also two VS Code commands which might be of interest: | |||
151 | $ cargo install --path crates/ra_lsp_server --force --features jemalloc | 153 | $ cargo install --path crates/ra_lsp_server --force --features jemalloc |
152 | ``` | 154 | ``` |
153 | 155 | ||
154 | There's an alias for this: `cargo jinstall-lsp`. | 156 | There's an alias for this: `cargo install-ra --server --jemalloc`. |
155 | 157 | ||
156 | * `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection. | 158 | * `Rust Analyzer: Syntax Tree` shows syntax tree of the current file/selection. |
157 | 159 | ||
diff --git a/docs/user/README.md b/docs/user/README.md index d56330192..a5e17f604 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
@@ -1,6 +1,6 @@ | |||
1 | The main interface to rust-analyzer is the | 1 | The main interface to rust-analyzer is the |
2 | [LSP](https://microsoft.github.io/language-server-protocol/) implementation. To | 2 | [LSP](https://microsoft.github.io/language-server-protocol/) implementation. To |
3 | install lsp server, use `cargo install-lsp`, which is a shorthand for `cargo | 3 | install lsp server, use `cargo install-ra --server`, which is a shorthand for `cargo |
4 | install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you | 4 | install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you |
5 | should be able to use it with any LSP-compatible editor. We use custom | 5 | should be able to use it with any LSP-compatible editor. We use custom |
6 | extensions to LSP, so special client-side support is required to take full | 6 | extensions to LSP, so special client-side support is required to take full |
@@ -33,7 +33,7 @@ following commands: | |||
33 | ``` | 33 | ``` |
34 | $ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1 | 34 | $ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1 |
35 | $ cd rust-analyzer | 35 | $ cd rust-analyzer |
36 | $ cargo install-code | 36 | $ cargo install-ra |
37 | ``` | 37 | ``` |
38 | 38 | ||
39 | The automatic installation is expected to *just work* for common cases, if it | 39 | The automatic installation is expected to *just work* for common cases, if it |
@@ -58,6 +58,9 @@ Beyond basic LSP features, there are some extension commands which you can | |||
58 | invoke via <kbd>Ctrl+Shift+P</kbd> or bind to a shortcut. See [./features.md](./features.md) | 58 | invoke via <kbd>Ctrl+Shift+P</kbd> or bind to a shortcut. See [./features.md](./features.md) |
59 | for details. | 59 | for details. |
60 | 60 | ||
61 | For updates, pull the latest changes from the master branch, run `cargo install-ra` again, and **restart** VS Code instance. | ||
62 | See https://github.com/microsoft/vscode/issues/72308[microsoft/vscode#72308] for why a full restart is needed. | ||
63 | |||
61 | ### Settings | 64 | ### Settings |
62 | 65 | ||
63 | * `rust-analyzer.highlightingOn`: enables experimental syntax highlighting | 66 | * `rust-analyzer.highlightingOn`: enables experimental syntax highlighting |
@@ -86,7 +89,7 @@ Installation: | |||
86 | [ra-emacs-lsp.el](https://github.com/rust-analyzer/rust-analyzer/blob/69ee5c9c5ef212f7911028c9ddf581559e6565c3/editors/emacs/ra-emacs-lsp.el) | 89 | [ra-emacs-lsp.el](https://github.com/rust-analyzer/rust-analyzer/blob/69ee5c9c5ef212f7911028c9ddf581559e6565c3/editors/emacs/ra-emacs-lsp.el) |
87 | to load path and require it in `init.el` | 90 | to load path and require it in `init.el` |
88 | * run `lsp` in a rust buffer | 91 | * run `lsp` in a rust buffer |
89 | * (Optionally) bind commands like `rust-analyzer-join-lines` or `rust-analyzer-extend-selection` to keys | 92 | * (Optionally) bind commands like `rust-analyzer-join-lines` or `rust-analyzer-extend-selection` to keys, and enable `rust-analyzer-inlay-hints-mode` to get inline type hints |
90 | 93 | ||
91 | 94 | ||
92 | ## Vim and NeoVim | 95 | ## Vim and NeoVim |