diff options
author | Veetaha <[email protected]> | 2020-02-09 18:19:23 +0000 |
---|---|---|
committer | Veetaha <[email protected]> | 2020-02-09 18:19:23 +0000 |
commit | e18661f62b884ba970f8b3267400bf4320c7b118 (patch) | |
tree | de826bb15d8e336f2e9098d624b1d1d6e0eb14bb | |
parent | 1b9b13b4b4a75b5531c3f046ce6bf72d681f2732 (diff) |
docs: Freshen docs for prebuilt binaries and raLspServer setting
-rw-r--r-- | docs/dev/README.md | 11 | ||||
-rw-r--r-- | docs/user/README.md | 17 |
2 files changed, 23 insertions, 5 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index 732e4bdd3..991deaf90 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -74,7 +74,7 @@ relevant test and execute it (VS Code includes an action for running a single | |||
74 | test). | 74 | test). |
75 | 75 | ||
76 | However, launching a VS Code instance with locally build language server is | 76 | However, launching a VS Code instance with locally build language server is |
77 | possible. There's "Run Extension (Dev Server)" launch configuration for this. | 77 | possible. There's **"Run Extension (Dev Server)"** launch configuration for this. |
78 | 78 | ||
79 | In general, I use one of the following workflows for fixing bugs and | 79 | In general, I use one of the following workflows for fixing bugs and |
80 | implementing features. | 80 | implementing features. |
@@ -88,7 +88,14 @@ Code to sanity check that the thing works as I expect. | |||
88 | 88 | ||
89 | If the problem concerns only the VS Code extension, I use **Run Extension** | 89 | If the problem concerns only the VS Code extension, I use **Run Extension** |
90 | launch configuration from `launch.json`. Notably, this uses the usual | 90 | launch configuration from `launch.json`. Notably, this uses the usual |
91 | `ra_lsp_server` binary from `PATH`. After I am done with the fix, I use `cargo | 91 | `ra_lsp_server` binary from `PATH`. For this it is important to have the following |
92 | in `setting.json` file: | ||
93 | ```json | ||
94 | { | ||
95 | "rust-analyzer.raLspServerPath": "ra_lsp_server" | ||
96 | } | ||
97 | ``` | ||
98 | After I am done with the fix, I use `cargo | ||
92 | xtask install --client-code` to try the new extension for real. | 99 | xtask install --client-code` to try the new extension for real. |
93 | 100 | ||
94 | If I need to fix something in the `ra_lsp_server` crate, I feel sad because it's | 101 | If I need to fix something in the `ra_lsp_server` crate, I feel sad because it's |
diff --git a/docs/user/README.md b/docs/user/README.md index 3da30a193..1e7d516c5 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
@@ -57,7 +57,7 @@ For updates you need to remove installed binary | |||
57 | rm -rf ${HOME}/.config/Code/User/globalStorage/matklad.rust-analyzer | 57 | rm -rf ${HOME}/.config/Code/User/globalStorage/matklad.rust-analyzer |
58 | ``` | 58 | ``` |
59 | 59 | ||
60 | `"Donwload latest language server"` command for VSCode and automatic updates detection is currently WIP. | 60 | `"Download latest language server"` command for VSCode and automatic updates detection is currently WIP. |
61 | 61 | ||
62 | 62 | ||
63 | ### Installation from sources | 63 | ### Installation from sources |
@@ -71,6 +71,16 @@ $ cd rust-analyzer | |||
71 | $ cargo xtask install | 71 | $ cargo xtask install |
72 | ``` | 72 | ``` |
73 | 73 | ||
74 | After that you need to amend your `settings.json` file to explicitly specify the | ||
75 | path to `ra_lsp_server` that you've just built. | ||
76 | ```json | ||
77 | { | ||
78 | "rust-analyzer.raLspServerPath": "ra_lsp_server" | ||
79 | } | ||
80 | ``` | ||
81 | This should work on all platforms, otherwise if installed `ra_lsp_server` is not available through your `$PATH` then see how to configure it [here](#setting-up-the-PATH-variable). | ||
82 | |||
83 | |||
74 | The automatic installation is expected to *just work* for common cases, if it | 84 | The automatic installation is expected to *just work* for common cases, if it |
75 | doesn't, report bugs! | 85 | doesn't, report bugs! |
76 | 86 | ||
@@ -127,7 +137,7 @@ host. | |||
127 | As an example, [Pale Fire](https://github.com/matklad/pale-fire/) color scheme tweaks rust colors. | 137 | As an example, [Pale Fire](https://github.com/matklad/pale-fire/) color scheme tweaks rust colors. |
128 | * `rust-analyzer.enableEnhancedTyping`: by default, rust-analyzer intercepts the | 138 | * `rust-analyzer.enableEnhancedTyping`: by default, rust-analyzer intercepts the |
129 | `Enter` key to make it easier to continue comments. Note that it may conflict with VIM emulation plugin. | 139 | `Enter` key to make it easier to continue comments. Note that it may conflict with VIM emulation plugin. |
130 | * `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable | 140 | * `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable, when absent or `null` defaults to prebuilt binary path |
131 | * `rust-analyzer.enableCargoWatchOnStartup`: prompt to install & enable `cargo | 141 | * `rust-analyzer.enableCargoWatchOnStartup`: prompt to install & enable `cargo |
132 | watch` for live error highlighting (note, this **does not** use rust-analyzer) | 142 | watch` for live error highlighting (note, this **does not** use rust-analyzer) |
133 | * `rust-analyzer.excludeGlobs`: a list of glob-patterns for exclusion (see globset [docs](https://docs.rs/globset) for syntax). | 143 | * `rust-analyzer.excludeGlobs`: a list of glob-patterns for exclusion (see globset [docs](https://docs.rs/globset) for syntax). |
@@ -232,7 +242,8 @@ Installation: | |||
232 | 242 | ||
233 | * You can now invoke the command palette and type LSP enable to locally/globally enable the rust-analyzer LSP (type LSP enable, then choose either locally or globally, then select rust-analyzer) | 243 | * You can now invoke the command palette and type LSP enable to locally/globally enable the rust-analyzer LSP (type LSP enable, then choose either locally or globally, then select rust-analyzer) |
234 | 244 | ||
235 | ### Setting up the `PATH` variable | 245 | |
246 | ### Setting up the `PATH` variable <!-- Update links to this header when changing it! --> | ||
236 | 247 | ||
237 | On Unix systems, `rustup` adds `~/.cargo/bin` to `PATH` by modifying the shell's | 248 | On Unix systems, `rustup` adds `~/.cargo/bin` to `PATH` by modifying the shell's |
238 | startup file. Depending on your configuration, your Desktop Environment might not | 249 | startup file. Depending on your configuration, your Desktop Environment might not |