summaryrefslogtreecommitdiff
path: root/doc/ale-rust.txt
diff options
context:
space:
mode:
authorrobertking <superobertking@icloud.com>2019-04-11 21:25:08 +0800
committerrobertking <superobertking@icloud.com>2019-04-11 23:05:59 +0800
commitdf806c511c3a3e0a1a7d8ad2ecd43484f98a94aa (patch)
tree5dccf1e1fc36930d792550858383384a53ce251b /doc/ale-rust.txt
parent481316561445a4048a96a2c6bd41e9b623d8919f (diff)
downloadale-df806c511c3a3e0a1a7d8ad2ecd43484f98a94aa.zip
change default value of ale_rust_rls_toolchain and update documentation
Diffstat (limited to 'doc/ale-rust.txt')
-rw-r--r--doc/ale-rust.txt8
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/ale-rust.txt b/doc/ale-rust.txt
index 3393b9c0..44a79b18 100644
--- a/doc/ale-rust.txt
+++ b/doc/ale-rust.txt
@@ -164,10 +164,14 @@ g:ale_rust_rls_executable *g:ale_rust_rls_executable*
g:ale_rust_rls_toolchain *g:ale_rust_rls_toolchain*
*b:ale_rust_rls_toolchain*
Type: |String|
- Default: `'nightly'`
+ Default: `''`
This option can be set to change the toolchain used for `rls`. Possible
- values include `'nightly'`, `'beta'`, and `'stable'`.
+ values include `'nightly'`, `'beta'`, `'stable'`, and `''`. When using
+ option `''`, rls will automatically find the default toolchain set by
+ rustup. If you want to use `rls` from a specific toolchain version, you may
+ also use values like `'channel-yyyy-mm-dd-arch-target'` as long as
+ `'rls +{toolchain_name} -V'` runs correctly in your command line.
The `rls` server will only be started once per executable.