Skip to content

Commit

Permalink
Auto merge of #15764 - Wilfred:emacs_docs, r=lnicola
Browse files Browse the repository at this point in the history
Expand Emacs documentation

Emacs 29 is now released, and include an example of enabling clippy.
  • Loading branch information
bors committed Oct 16, 2023
2 parents 6572ec8 + 03bec11 commit 983094a
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/user/manual.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ To use `rust-analyzer`, you need to install and enable one of the two popular LS

==== Eglot

Eglot is the more minimalistic and lightweight LSP client for Emacs, integrates well with existing Emacs functionality and will be built into Emacs starting from release 29.
Eglot is the more minimalistic and lightweight LSP client for Emacs, integrates well with existing Emacs functionality and is built into Emacs starting from release 29.

After installing Eglot, e.g. via `M-x package-install` (not needed from Emacs 29), you can enable it via the `M-x eglot` command or load it automatically in `rust-mode` via

Expand All @@ -246,6 +246,15 @@ After installing Eglot, e.g. via `M-x package-install` (not needed from Emacs 29
(add-hook 'rust-mode-hook 'eglot-ensure)
----

To enable clippy, you will need to configure the initialization options to pass the `check.command` setting.

[source,emacs-lisp]
----
(add-to-list 'eglot-server-programs
'((rust-ts-mode rust-mode) .
("rust-analyzer" :initializationOptions (:check (:command "clippy")))))
----

For more detailed instructions and options see the https://joaotavora.github.io/eglot[Eglot manual] (also available from Emacs via `M-x info`) and the
https://github.com/joaotavora/eglot/blob/master/README.md[Eglot readme].

Expand Down

0 comments on commit 983094a

Please sign in to comment.