aboutsummaryrefslogtreecommitdiff
path: root/docs/user/README.md
diff options
context:
space:
mode:
authorbors[bot] <26634292+bors[bot]@users.noreply.github.com>2019-10-22 09:09:03 +0100
committerGitHub <[email protected]>2019-10-22 09:09:03 +0100
commit2dffae6f35ce4b5824df881a5c190daabd3efd3c (patch)
tree67a72b4f37e7c2581486785b8aeb9d1682806a46 /docs/user/README.md
parent8f4480d180386541b8f918bda14479f9a896eb85 (diff)
parent46656222ed009831568aae7444429faf8005f242 (diff)
Merge #2043
2043: Instructions for VS Code Remote Development r=matklad a=marcogroppo `rust-analyzer` can be used with the Visual Studio Code Remote Development extension pack, but `cargo xtask install` is not enough, you have to install the `VSIX` package from VS Code. These instructions have been added to the `README`. Co-authored-by: Marco Groppo <[email protected]>
Diffstat (limited to 'docs/user/README.md')
-rw-r--r--docs/user/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/user/README.md b/docs/user/README.md
index f45c0d7d1..f1628d6a4 100644
--- a/docs/user/README.md
+++ b/docs/user/README.md
@@ -61,6 +61,25 @@ for details.
61For updates, pull the latest changes from the master branch, run `cargo xtask install` again, and **restart** VS Code instance. 61For updates, pull the latest changes from the master branch, run `cargo xtask install` again, and **restart** VS Code instance.
62See [microsoft/vscode#72308](https://github.com/microsoft/vscode/issues/72308) for why a full restart is needed. 62See [microsoft/vscode#72308](https://github.com/microsoft/vscode/issues/72308) for why a full restart is needed.
63 63
64### VS Code Remote
65
66You can also use `rust-analyzer` with the Visual Studio Code Remote extensions
67(Remote SSH, Remote WSL, Remote Containers). In this case, however, you have to
68manually install the `.vsix` package:
69
701. Build the extension on the remote host using the instructions above (ignore the
71 error if `code` cannot be found in your PATH: VSCode doesn't need to be installed
72 on the remote host).
732. In Visual Studio Code open a connection to the remote host.
743. Open the Extensions View (`View > Extensions`, keyboard shortcut: `Ctrl+Shift+X`).
754. From the top-right kebab menu (`ยทยทยท`) select `Install from VSIX...`
765. Inside the `rust-analyzer` directory find the `editors/code` subdirectory and choose
77 the `ra-lsp-0.0.1.vsix` file.
786. Restart Visual Studio Code and re-establish the connection to the remote host.
79
80In case of errors please make sure that `~/.cargo/bin` is in your `PATH` on the remote
81host.
82
64### Settings 83### Settings
65 84
66* `rust-analyzer.highlightingOn`: enables experimental syntax highlighting 85* `rust-analyzer.highlightingOn`: enables experimental syntax highlighting