about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2022-08-23 14:48:28 +0000
committerbors <bors@rust-lang.org>2022-08-23 14:48:28 +0000
commit27e17ffd27ac850a2fc7de1d36a83ef440322255 (patch)
tree4229c31f38aeb15915a4beb46771b87f23afd2e9
parente73b7a9ec793095e35dbde8c0ea9347c0fbf7fed (diff)
parent0cc1a89e08b26a7e9aa4b215f9e3ccc1b667ff58 (diff)
downloadrust-27e17ffd27ac850a2fc7de1d36a83ef440322255.tar.gz
rust-27e17ffd27ac850a2fc7de1d36a83ef440322255.zip
Auto merge of #13097 - jonas-schievink:liveshare-docs, r=jonas-schievink
minor: 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.