aboutsummaryrefslogtreecommitdiff
path: root/docs/user/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user/README.md')
-rw-r--r--docs/user/README.md19
1 files changed, 16 insertions, 3 deletions
diff --git a/docs/user/README.md b/docs/user/README.md
index f1628d6a4..eb1d5ed14 100644
--- a/docs/user/README.md
+++ b/docs/user/README.md
@@ -83,8 +83,6 @@ host.
83### Settings 83### Settings
84 84
85* `rust-analyzer.highlightingOn`: enables experimental syntax highlighting 85* `rust-analyzer.highlightingOn`: enables experimental syntax highlighting
86* `rust-analyzer.showWorkspaceLoadedNotification`: to ease troubleshooting, a
87 notification is shown by default when a workspace is loaded
88* `rust-analyzer.enableEnhancedTyping`: by default, rust-analyzer intercepts 86* `rust-analyzer.enableEnhancedTyping`: by default, rust-analyzer intercepts
89 `Enter` key to make it easier to continue comments. Note that it may conflict with VIM emulation plugin. 87 `Enter` key to make it easier to continue comments. Note that it may conflict with VIM emulation plugin.
90* `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable 88* `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable
@@ -102,6 +100,17 @@ host.
102* `rust-analyzer.trace.server`: enables internal logging 100* `rust-analyzer.trace.server`: enables internal logging
103* `rust-analyzer.trace.cargo-watch`: enables cargo-watch logging 101* `rust-analyzer.trace.cargo-watch`: enables cargo-watch logging
104* `RUST_SRC_PATH`: environment variable that overwrites the sysroot 102* `RUST_SRC_PATH`: environment variable that overwrites the sysroot
103* `rust-analyzer.featureFlags` -- a JSON object to tweak fine-grained behavior:
104 ```js
105 {
106 // Show diagnostics produced by rust-analyzer itself.
107 "lsp.diagnostics": true,
108 // Automatically insert `()` and `<>` when completing functions and types.
109 "completion.insertion.add-call-parenthesis": true,
110 // Show notification when workspace is fully loaded
111 "notifications.workspace-loaded": true,
112 }
113 ```
105 114
106 115
107## Emacs 116## Emacs
@@ -173,7 +182,11 @@ Installation:
173 "syntaxes": [ 182 "syntaxes": [
174 "Packages/Rust/Rust.sublime-syntax", 183 "Packages/Rust/Rust.sublime-syntax",
175 "Packages/Rust Enhanced/RustEnhanced.sublime-syntax" 184 "Packages/Rust Enhanced/RustEnhanced.sublime-syntax"
176 ] 185 ],
186 "initializationOptions": {
187 "featureFlags": {
188 }
189 },
177} 190}
178``` 191```
179 192