Skip to content

Commit 9597e55

Browse files
bors[bot]lnicola
andauthored
Merge #11406
11406: Update install notes for bundled servers r=stanciuadrian a=lnicola r? `@stanciuadrian` Co-authored-by: Laurențiu Nicola <[email protected]>
2 parents 6162d12 + befaa87 commit 9597e55

File tree

1 file changed

+13
-27
lines changed

1 file changed

+13
-27
lines changed

docs/user/manual.adoc

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -67,16 +67,16 @@ To disable this notification put the following to `settings.json`
6767
----
6868
====
6969

70-
The server binary is stored in:
70+
The server binary is stored in the extension install directory, which starts with `matklad.rust-analyzer-` and is located under:
7171

72-
* Linux: `~/.config/Code/User/globalStorage/matklad.rust-analyzer`
73-
* Linux (Remote, such as WSL): `~/.vscode-server/data/User/globalStorage/matklad.rust-analyzer`
74-
* macOS: `~/Library/Application\ Support/Code/User/globalStorage/matklad.rust-analyzer`
75-
* Windows: `%APPDATA%\Code\User\globalStorage\matklad.rust-analyzer`
72+
* Linux: `~/.vscode/extensions`
73+
* Linux (Remote, such as WSL): `~/.vscode-server/extensions`
74+
* macOS: `~/.vscode/extensions`
75+
* Windows: `%USERPROFILE%\.vscode\extensions`
7676

77-
However, if you are using a version of the extension with a bundled server binary and you are not running NixOS, the server binary might be instead running from: `~/.vscode/extensions/matklad.rust-analyzer-VERSION`.
77+
As an exception, on NixOS, the extension makes a copy of the server and stores it under `~/.config/Code/User/globalStorage/matklad.rust-analyzer`.
7878

79-
Note that we only support two most recent versions of VS Code.
79+
Note that we only support the two most recent versions of VS Code.
8080

8181
==== Updates
8282

@@ -86,27 +86,12 @@ It will ask your permission to download the matching language server version bin
8686
===== Nightly
8787

8888
We ship nightly releases for VS Code.
89+
You can opt in to these by switching to the pre-release version in the Code extension page or settings.
8990
To help us out with testing the newest code and follow the bleeding edge of our `master`, please use the following config:
9091

91-
[source,json]
92-
----
93-
{ "rust-analyzer.updates.channel": "nightly" }
94-
----
95-
96-
You will be prompted to install the `nightly` extension version.
97-
Just click `Download now` and from that moment you will get automatic updates every 24 hours.
98-
99-
If you don't want to be asked for `Download now` every day when the new nightly version is released add the following to your `settings.json`:
100-
[source,json]
101-
----
102-
{ "rust-analyzer.updates.askBeforeDownload": false }
103-
----
104-
105-
NOTE: Nightly extension should **only** be installed via the `Download now` action from VS Code.
106-
10792
==== Manual installation
10893

109-
Alternatively, procure both `rust-analyzer.vsix` and your platform's matching `rust-analyzer-{platform}`, for example from the
94+
Alternatively, download a VSIX corresponding to your platform from the
11095
https://github.com/rust-analyzer/rust-analyzer/releases[releases] page.
11196

11297
Install the extension with the `Extensions: Install from VSIX` command within VS Code, or from the command line via:
@@ -115,23 +100,24 @@ Install the extension with the `Extensions: Install from VSIX` command within VS
115100
$ code --install-extension /path/to/rust-analyzer.vsix
116101
----
117102

118-
Copy the `rust-analyzer-{platform}` binary anywhere, then add the path to your settings.json, for example:
103+
If you are running an unsupported platform, you can install `rust-analyzer-no-server.vsix` and compile or obtain a server binary.
104+
Copy the server anywhere, then add the path to your settings.json, for example:
119105
[source,json]
120106
----
121107
{ "rust-analyzer.server.path": "~/.local/bin/rust-analyzer-linux" }
122108
----
123109

124110
==== Building From Source
125111

126-
Alternatively, both the server and the Code plugin can be installed from source:
112+
Both the server and the Code plugin can be installed from source:
127113

128114
[source]
129115
----
130116
$ git clone https://github.com/rust-analyzer/rust-analyzer.git && cd rust-analyzer
131117
$ cargo xtask install
132118
----
133119

134-
You'll need Cargo, nodejs and npm for this.
120+
You'll need Cargo, nodejs (matching a supported version of VS Code) and npm for this.
135121

136122
Note that installing via `xtask install` does not work for VS Code Remote, instead you'll need to install the `.vsix` manually.
137123

0 commit comments

Comments
 (0)