Skip to content

Commit e40aa42

Browse files
Add troubleshooting FAQ to the book
And one frequently asked question.
1 parent 9a0434e commit e40aa42

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

src/tools/rust-analyzer/docs/book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- [rust-analyzer Binary](rust_analyzer_binary.md)
77
- [Other Editors](other_editors.md)
88
- [Troubleshooting](troubleshooting.md)
9+
- [FAQ](faq.md)
910
- [Configuration](configuration.md)
1011
- [Non-Cargo Based Projects](non_cargo_based_projects.md)
1112
- [Security](security.md)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Troubleshooting FAQ
2+
3+
### I see a warning "Variable `None` should have snake_case name, e.g. `none`"
4+
5+
rust-analyzer fails to resolve `None`, and thinks you are binding to a variable
6+
named `None`. That's usually a sign of a corrupted sysroot. Try removing and re-installing
7+
it: `rustup component remove rust-src` then `rustup component install rust-src`.

src/tools/rust-analyzer/docs/book/src/troubleshooting.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Troubleshooting
22

3+
First, search the [troubleshooting FAQ](troubleshooting/faq.html). If
4+
your problem appears there (and the proposed solution works for you),
5+
great! Otherwise, read on.
6+
37
Start with looking at the rust-analyzer version. Try **rust-analyzer:
48
Show RA Version** in VS Code (using **Command Palette** feature
59
typically activated by Ctrl+Shift+P) or `rust-analyzer --version` in the

0 commit comments

Comments
 (0)