about summary refs log tree commit diff
diff options
context:
space:
mode:
authorJan Tache <j.andreitabs@gmail.com>2022-02-21 22:37:19 -0800
committerJan Tache <j.andreitabs@gmail.com>2022-02-21 22:54:25 -0800
commit08461cc8f03e3f1f462970331fa74233b9b62ba6 (patch)
tree62c64a9bbe7c42c40a4450edf6150b4ad803db18
parentc0ee2f23ff70349704dfe8448027a41b7788eb37 (diff)
downloadrust-08461cc8f03e3f1f462970331fa74233b9b62ba6.tar.gz
rust-08461cc8f03e3f1f462970331fa74233b9b62ba6.zip
doc: state that only the latest stable toolchain is supported
This closes #11226. The content seemed to make more sense in the
installation section as opposed to the Troubleshooting section.
-rw-r--r--docs/user/manual.adoc14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc
index 2b1eae1e2a4..dfaa34fc9aa 100644
--- a/docs/user/manual.adoc
+++ b/docs/user/manual.adoc
@@ -40,6 +40,20 @@ To add the sources manually, run the following command:
 $ rustup component add rust-src
 ```
 
+=== Toolchain
+
+Rust Analyzer only officially supports using the latest stable toolchain.
+If you are using an older toolchain or have an override set, Rust Analyzer may fail to understand the Rust source.
+You will either need to update your toolchain or use an older version of Rust Analyzer that is compatible with your toolchain.
+
+If you are using an override in your project, you can still force Rust Analyzer to use the stable toolchain via the environment variable `RUSTUP_TOOLCHAIN`.
+For example, with VS Code or coc-rust-analyzer:
+
+[source,json]
+----
+{ "rust-analyzer.server.extraEnv": { "RUSTUP_TOOLCHAIN": "stable" } }
+----
+
 === VS Code
 
 This is the best supported editor at the moment.