From b771425f45f279a87e042ec9cf96f55f5bc6ff17 Mon Sep 17 00:00:00 2001 From: Colin Woodbury Date: Mon, 17 May 2021 07:24:55 -0700 Subject: [PATCH] [:lang rust] Expand `Prerequisites` And fix some minor spelling/grammar issues. --- modules/lang/rust/README.org | 36 ++++++++++++++++++++++++++++++++---- 1 file changed, 32 insertions(+), 4 deletions(-) diff --git a/modules/lang/rust/README.org b/modules/lang/rust/README.org index 63a0bec2c19..be0bfb38876 100644 --- a/modules/lang/rust/README.org +++ b/modules/lang/rust/README.org @@ -9,13 +9,17 @@ - [[#plugins][Plugins]] - [[#hacks][Hacks]] - [[#prerequisites][Prerequisites]] + - [[#install][Install]] + - [[#arch-linux][Arch Linux]] + - [[#general][General]] + - [[#other-requirements][Other Requirements]] - [[#features][Features]] - [[#lsp-support-rls-or-rust-analyzer][LSP support (rls or rust-analyzer)]] - [[#format-on-save][Format on save]] - [[#keybinds][Keybinds]] - [[#configuration][Configuration]] - [[#enable-rls-by-default][Enable RLS by default]] - - [[#enabling-elgot-support-for-rust][Enabling elgot support for Rust]] + - [[#enabling-eglot-support-for-rust][Enabling eglot support for Rust]] - [[#troubleshooting][Troubleshooting]] - [[#errore0670-async-fn-is-not-permitted-in-the-2015-edition][error[E0670]: `async fn` is not permitted in the 2015 edition]] @@ -42,9 +46,33 @@ e.g. ~cargo~. yourself. * Prerequisites -This module requires ~rust~, which can be acquired through =rustup=: -~curl https://sh.rustup.rs -sSf | sh~ +** Install + +This module requires ~rust~, which can be acquired through =rustup=. + +*** Arch Linux + +#+begin_src sh +sudo pacman -S rustup +#+end_src + +See also the Rust article [[https://wiki.archlinux.org/title/Rust#Rustup][on the Arch Wiki]]. + +Note that when the Rust /language/ has updates, you are to run =rustup= such that +it doesn't upgrade itself: + +#+begin_src sh +rustup update --no-self-update +#+end_src + +*** General + +#+begin_src sh +curl https://sh.rustup.rs -sSf | sh +#+end_src + +** Other Requirements Additional requirements depend on the module's configuration: @@ -54,7 +82,7 @@ Additional requirements depend on the module's configuration: (with requires rust nightly edition). + Users with =+lsp= enabled will need: + =rust-analyzer= or =rls= -+ To use The following commands require: ++ Using the following commands requires: + ~cargo-process-check~: ~cargo install cargo-check~ + ~cargo-process-clippy~: ~rustup component add clippy-preview~