about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJonas Schievink <jonas.schievink@ferrous-systems.com>2022-08-23 16:47:26 +0200
committerJonas Schievink <jonas.schievink@ferrous-systems.com>2022-08-23 16:47:26 +0200
commit0cc1a89e08b26a7e9aa4b215f9e3ccc1b667ff58 (patch)
tree6494554328bf2899df5b432f357bc55aa98e0ba2
parentf045f146263b1816f0b3472b528841b5877c020f (diff)
downloadrust-0cc1a89e08b26a7e9aa4b215f9e3ccc1b667ff58.tar.gz
rust-0cc1a89e08b26a7e9aa4b215f9e3ccc1b667ff58.zip
Add a short blurb about VS Code Live Share to the manual
-rw-r--r--docs/user/manual.adoc11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc
index c482fcbed0e..9bd3b6a692b 100644
--- a/docs/user/manual.adoc
+++ b/docs/user/manual.adoc
@@ -861,3 +861,14 @@ For example, if you want to run https://crates.io/crates/cargo-watch[`cargo watc
     "isBackground": true
 }
 ```
+
+==== Live Share
+
+VS Code Live Share has partial support for rust-analyzer.
+
+Live Share _requires_ the official Microsoft build of VS Code, OSS builds will not work correctly.
+
+The host's rust-analyzer instance will be shared with all guests joining the session.
+The guests do not have to have the rust-analyzer extension installed for this to work.
+
+If you are joining a Live Share session and _do_ have rust-analyzer installed locally, commands from the command palette will not work correctly since they will attempt to communicate with the local server.