From a1c9d40ee896fc4aada47f48c1bc161326451f1a Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Wed, 7 Sep 2022 01:21:44 +0200 Subject: [PATCH] docs(rust): de-emphasize rls 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 --- modules/lang/rust/README.org | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/modules/lang/rust/README.org b/modules/lang/rust/README.org index 6b2e1e9bb..e43168136 100644 --- a/modules/lang/rust/README.org +++ b/modules/lang/rust/README.org @@ -20,7 +20,7 @@ e.g. ~cargo~. ** Module flags - +lsp :: 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 - [[doom-package:][rustic]] @@ -65,10 +65,10 @@ rustup update --no-self-update ** LSP support (rls or rust-analyzer) 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 - OS package manager). -2. The [[doom-module:][:tools lsp]] module enabled. -3. The [[doom-module:][+lsp]] flag on this module enabled. +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 + too, but it is [[https://blog.rust-lang.org/2022/07/01/RLS-deprecation.html][deprecated]]). +2. To enable the [[doom-module:][:tools lsp]] module. +3. To enable the [[doom-module:][+lsp]] flag on this module. ** Format on save 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?]] #+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 Doom's [[doom-module:][:tools lsp]] module has an [[doom-module:][+eglot]] flag. Enable it and this module will use eglot instead.