aboutsummaryrefslogtreecommitdiff
path: root/docs/user/readme.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user/readme.adoc')
-rw-r--r--docs/user/readme.adoc14
1 files changed, 12 insertions, 2 deletions
diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc
index 40ed54809..64bd0feb1 100644
--- a/docs/user/readme.adoc
+++ b/docs/user/readme.adoc
@@ -9,8 +9,6 @@
9:caution-caption: :fire: 9:caution-caption: :fire:
10:warning-caption: :warning: 10:warning-caption: :warning:
11 11
12
13
14// Master copy of this document lives in the https://github.com/rust-analyzer/rust-analyzer repository 12// Master copy of this document lives in the https://github.com/rust-analyzer/rust-analyzer repository
15 13
16At its core, rust-analyzer is a *library* for semantic analysis of Rust code as it changes over time. 14At its core, rust-analyzer is a *library* for semantic analysis of Rust code as it changes over time.
@@ -21,6 +19,8 @@ The LSP allows various code editors, like VS Code, Emacs or Vim, to implement se
21To improve this document, send a pull request against 19To improve this document, send a pull request against
22https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/readme.adoc[this file]. 20https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/readme.adoc[this file].
23 21
22If you have questions about using rust-analyzer, please ask them in the https://users.rust-lang.org/c/ide/14["`IDEs and Editors`"] topic of Rust users forum.
23
24== Installation 24== Installation
25 25
26In theory, one should be able to just install the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>> and have it automatically work with any editor. 26In theory, one should be able to just install the <<rust-analyzer-language-server-binary,`rust-analyzer` binary>> and have it automatically work with any editor.
@@ -65,6 +65,16 @@ The server binary is stored in:
65 65
66Note that we only support two most recent versions of VS Code. 66Note that we only support two most recent versions of VS Code.
67 67
68==== Special `when` clause context for keybindings.
69You may use `inRustProject` context to configure keybindings for rust projects only. For example:
70[source,json]
71----
72{ "key": "ctrl+shift+f5", "command": "workbench.action.debug.restart", "when": "inDebugMode && !inRustProject"},
73{ "key": "ctrl+shift+f5", "command": "rust-analyzer.debug", "when": "inRustProject"},
74{ "key": "ctrl+i", "command": "rust-analyzer.toggleInlayHints", "when": "inRustProject" }
75----
76More about `when` clause contexts https://code.visualstudio.com/docs/getstarted/keybindings#_when-clause-contexts[here].
77
68==== Updates 78==== Updates
69 79
70The extension will be updated automatically as new versions become available. It will ask your permission to download the matching language server version binary if needed. 80The extension will be updated automatically as new versions become available. It will ask your permission to download the matching language server version binary if needed.