emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs(rust): de-emphasize rls

Browse source 
RLS has been deprecated for rust-analyzer, so it's best that our rust
module refrain from advertising it so prominently.

Ref: https://blog.rust-lang.org/2022/07/01/RLS-deprecation.html
This commit is contained in:
Henrik Lissner 2022-09-07 01:21:44 +02:00
parent 63b0ebeda7
commit a1c9d40ee8
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
1 changed files with 5 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

19
modules/lang/rust/README.org
View file

@ -20,7 +20,7 @@ e.g. ~cargo~.
** Module flags ** Module flags
- +lsp :: - +lsp ::
Enable LSP support for ~rustic-mode~. Requires [[doom-module:][:tools lsp]] and a langserver Enable LSP support for ~rustic-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports rust-analyzer and rls). (supports [[https://rust-analyzer.github.io/][rust-analyzer]] and rls).
** Packages ** Packages
- [[doom-package:][rustic]] - [[doom-package:][rustic]]
@ -65,10 +65,10 @@ rustup update --no-self-update
** LSP support (rls or rust-analyzer) ** LSP support (rls or rust-analyzer)
This module supports LSP integration. For it to work you'll need: This module supports LSP integration. For it to work you'll need:
1. Either [[https://github.com/rust-analyzer/rust-analyzer][rust-analyzer]] or [[https://github.com/rust-lang/rls][the Rust Language Server]] installed (e.g. through your 1. To install [[https://github.com/rust-analyzer/rust-analyzer][rust-analyzer]] through your OS package manager ([[https://github.com/rust-lang/rls][RLS]] is supported
OS package manager). too, but it is [[https://blog.rust-lang.org/2022/07/01/RLS-deprecation.html][deprecated]]).
2. The [[doom-module:][:tools lsp]] module enabled. 2. To enable the [[doom-module:][:tools lsp]] module.
3. The [[doom-module:][+lsp]] flag on this module enabled. 3. To enable the [[doom-module:][+lsp]] flag on this module.
** Format on save ** Format on save
Enable [[doom-module:][:editor format +onsave]] to get formatting on save with =rustfmt=. No Enable [[doom-module:][:editor format +onsave]] to get formatting on save with =rustfmt=. No
@ -94,15 +94,6 @@ additional configuration is necessary.
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]] 🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote #+end_quote
** Enable RLS by default
If both =rls= and =rust-analyzer= are present on your system, =rust-analyzer= is
used by default. Modify ~rustic-lsp-server~ to change the default:
#+begin_src emacs-lisp
;; in $DOOMDIR/config.el
(after! rustic
(setq rustic-lsp-server 'rls))
#+end_src
** Enabling eglot support for Rust ** Enabling eglot support for Rust
Doom's [[doom-module:][:tools lsp]] module has an [[doom-module:][+eglot]] flag. Enable it and this module will use Doom's [[doom-module:][:tools lsp]] module has an [[doom-module:][+eglot]] flag. Enable it and this module will use
eglot instead. eglot instead.