summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBen Boeckel <mathstuf@users.noreply.github.com>2023-07-24 00:35:54 +0000
committerGitHub <noreply@github.com>2023-07-24 09:35:54 +0900
commit1084152a117e28ed846f19e079f502ec686b6826 (patch)
tree8af66cef3a77535df28b7b1e1a150b84d70fdd61 /doc
parent29e5ffe35a2fa1ca5ba19eebfe7cdd0191c16e39 (diff)
downloadale-1084152a117e28ed846f19e079f502ec686b6826.zip
ale-rust: add an example for `rust-analyzer` configuration (#4559)
Closes: #4557
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-rust.txt14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt
index 36d69b5e..48f558e8 100644
--- a/doc/ale-rust.txt
+++ b/doc/ale-rust.txt
@@ -60,8 +60,20 @@ g:ale_rust_analyzer_config *g:ale_rust_analyzer_config*
Type: |Dictionary|
Default: `{}`
- Dictionary with configuration settings for rust-analyzer.
+ Dictionary with configuration settings for rust-analyzer. Keys of the
+ dictionary are components of configuration keys. For example:
+>
+ let g:ale_rust_analyzer_config = {
+ \ 'server': {
+ \ 'extraEnv': { 'RUSTUP_TOOLCHAIN': 'stable' },
+ \ }
+ \}
+<
+ corresponds to `rust-analyzer.server.extraEnv = { 'RUSTUP_TOOLCHAIN': 'stable' }`
+
+ For available configuration parameters, see the `rust-analyzer` manual:
+ https://rust-analyzer.github.io/manual.html#configuration
===============================================================================
cargo *ale-rust-cargo*