aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/README.md3
-rw-r--r--docs/dev/debugging.md5
-rw-r--r--docs/user/generated_config.adoc20
3 files changed, 22 insertions, 6 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md
index e81f1e74c..a394b8501 100644
--- a/docs/dev/README.md
+++ b/docs/dev/README.md
@@ -131,7 +131,8 @@ Logging is done by both rust-analyzer and VS Code, so it might be tricky to figu
131 131
132Inside rust-analyzer, we use the standard `log` crate for logging, and `env_logger` for logging frontend. 132Inside rust-analyzer, we use the standard `log` crate for logging, and `env_logger` for logging frontend.
133By default, log goes to stderr, but the stderr itself is processed by VS Code. 133By default, log goes to stderr, but the stderr itself is processed by VS Code.
134`--log-file <PATH>` CLI argument allows logging to file. 134`--log-file <PATH>` CLI argument allows logging to file.
135Setting the `RA_LOG_FILE=<PATH>` environment variable will also log to file, it will also override `--log-file`.
135 136
136To see stderr in the running VS Code instance, go to the "Output" tab of the panel and select `rust-analyzer`. 137To see stderr in the running VS Code instance, go to the "Output" tab of the panel and select `rust-analyzer`.
137This shows `eprintln!` as well. 138This shows `eprintln!` as well.
diff --git a/docs/dev/debugging.md b/docs/dev/debugging.md
index 5876e71bc..48caec1d8 100644
--- a/docs/dev/debugging.md
+++ b/docs/dev/debugging.md
@@ -65,6 +65,11 @@ If you need to debug the server from the very beginning, including its initializ
65 } 65 }
66``` 66```
67 67
68However for this to work, you will need to enable debug_assertions in your build
69```rust
70RUSTFLAGS='--cfg debug_assertions' cargo build --release
71```
72
68## Demo 73## Demo
69 74
70- [Debugging TypeScript VScode extension](https://www.youtube.com/watch?v=T-hvpK6s4wM). 75- [Debugging TypeScript VScode extension](https://www.youtube.com/watch?v=T-hvpK6s4wM).
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc
index 18ea77266..cc7fdd38f 100644
--- a/docs/user/generated_config.adoc
+++ b/docs/user/generated_config.adoc
@@ -39,6 +39,11 @@ Automatically refresh project info via `cargo metadata` on
39-- 39--
40Activate all available features (`--all-features`). 40Activate all available features (`--all-features`).
41-- 41--
42[[rust-analyzer.cargo.unsetTest]]rust-analyzer.cargo.unsetTest (default: `["core"]`)::
43+
44--
45Unsets `#[cfg(test)]` for the specified crates.
46--
42[[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`):: 47[[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`)::
43+ 48+
44-- 49--
@@ -210,6 +215,16 @@ In some editors (e.g. vscode) semantic tokens override other highlighting gramma
210By disabling semantic tokens for strings, other grammars can be used to highlight 215By disabling semantic tokens for strings, other grammars can be used to highlight
211their contents. 216their contents.
212-- 217--
218[[rust-analyzer.hover.documentation]]rust-analyzer.hover.documentation (default: `true`)::
219+
220--
221Whether to show documentation on hover.
222--
223[[rust-analyzer.hover.linksInHover]]rust-analyzer.hover.linksInHover (default: `true`)::
224+
225--
226Use markdown syntax for links in hover.
227--
213[[rust-analyzer.hoverActions.debug]]rust-analyzer.hoverActions.debug (default: `true`):: 228[[rust-analyzer.hoverActions.debug]]rust-analyzer.hoverActions.debug (default: `true`)::
214+ 229+
215-- 230--
@@ -245,11 +260,6 @@ Whether to show `References` action. Only applies when
245Whether to show `Run` action. Only applies when 260Whether to show `Run` action. Only applies when
246`#rust-analyzer.hoverActions.enable#` is set. 261`#rust-analyzer.hoverActions.enable#` is set.
247-- 262--
248[[rust-analyzer.hoverActions.linksInHover]]rust-analyzer.hoverActions.linksInHover (default: `true`)::
249+
250--
251Use markdown syntax for links in hover.
252--
253[[rust-analyzer.inlayHints.chainingHints]]rust-analyzer.inlayHints.chainingHints (default: `true`):: 263[[rust-analyzer.inlayHints.chainingHints]]rust-analyzer.inlayHints.chainingHints (default: `true`)::
254+ 264+
255-- 265--