aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAleksey Kladov <[email protected]>2019-07-29 10:14:11 +0100
committerAleksey Kladov <[email protected]>2019-07-29 10:14:11 +0100
commit2c70bb4dd882d88f7dacb6b46bd1560cce1b9d11 (patch)
tree1b78b20ca0478c6d29f0ea4f97b58a7ed5d1f37b /docs
parente2f65f61af2ab5c2b337875a29378419ef965612 (diff)
document upgrade process
closes #1615
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/README.md2
-rw-r--r--docs/user/README.md3
2 files changed, 5 insertions, 0 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
index 74c58d4af..0db3e731e 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -116,6 +116,8 @@ Due to the requirements of running the tests inside VS Code they are **not run
116on CI**. When making changes to the extension please ensure the tests are not 116on CI**. When making changes to the extension please ensure the tests are not
117broken locally before opening a Pull Request. 117broken locally before opening a Pull Request.
118 118
119To install **only** the VS Code extension, use `cargo install-ra --client-code`.
120
119# Logging 121# Logging
120 122
121Logging is done by both rust-analyzer and VS Code, so it might be tricky to 123Logging is done by both rust-analyzer and VS Code, so it might be tricky to
diff --git a/docs/user/README.md b/docs/user/README.md
index 122388a42..a5e17f604 100644
--- a/docs/user/README.md
+++ b/docs/user/README.md
@@ -58,6 +58,9 @@ Beyond basic LSP features, there are some extension commands which you can
58invoke via <kbd>Ctrl+Shift+P</kbd> or bind to a shortcut. See [./features.md](./features.md) 58invoke via <kbd>Ctrl+Shift+P</kbd> or bind to a shortcut. See [./features.md](./features.md)
59for details. 59for details.
60 60
61For updates, pull the latest changes from the master branch, run `cargo install-ra` again, and **restart** VS Code instance.
62See https://github.com/microsoft/vscode/issues/72308[microsoft/vscode#72308] for why a full restart is needed.
63
61### Settings 64### Settings
62 65
63* `rust-analyzer.highlightingOn`: enables experimental syntax highlighting 66* `rust-analyzer.highlightingOn`: enables experimental syntax highlighting