about summary refs log tree commit diff
diff options
context:
space:
mode:
authorLaurențiu Nicola <lnicola@users.noreply.github.com>2025-02-26 15:31:24 +0000
committerGitHub <noreply@github.com>2025-02-26 15:31:24 +0000
commit444ce09d53eb7bf966f155a322407924fc6ce8cd (patch)
tree272b247c4889000b846b8328bc09888d0d861635
parentaa32933982aa5fb02e11403741bc3f21edea2240 (diff)
parent91ff4208d110c57fe76734013c33edb05936f8e9 (diff)
downloadrust-444ce09d53eb7bf966f155a322407924fc6ce8cd.tar.gz
rust-444ce09d53eb7bf966f155a322407924fc6ce8cd.zip
Merge pull request #19220 from Shourya742/2025-02-24-nit-setup-doc
doc: remove nit from setup.md
-rw-r--r--src/tools/rust-analyzer/docs/book/src/contributing/setup.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/src/tools/rust-analyzer/docs/book/src/contributing/setup.md b/src/tools/rust-analyzer/docs/book/src/contributing/setup.md
index d8a7840d376..eab65e779ed 100644
--- a/src/tools/rust-analyzer/docs/book/src/contributing/setup.md
+++ b/src/tools/rust-analyzer/docs/book/src/contributing/setup.md
@@ -17,10 +17,13 @@ Since rust-analyzer is a Rust project, you will need to install Rust. You can do
 **Step 04**: Install the language server locally by running the following command:
 
 ```sh
-cargo xtask install --server --code-bin code-insiders --dev-rel
+# Install only the language server  
+cargo xtask install --server \  
+    --code-bin code-insiders \  # Target a specific editor (code, code-exploration, code-insiders, codium, or code-oss)  
+    --dev-rel  # Build in release mode with debug info level 2  
 ```
 
-In the output of this command, there should be a file path provided to the installed binary on  your local machine.
+In the output of this command, there should be a file path provided to the installed binary on your local machine.
 It should look something like the following output below:
 
 ```
@@ -48,9 +51,12 @@ An example debugging statement could go into the `main_loop.rs` file which can b
 ```rs
 eprintln!("Hello, world!");
 ```
+Now, run the following commands to check the project and reinstall the server:  
 
-Now we run `cargo build` and `sh
-cargo xtask install --server --code-bin code-insiders --dev-rel` to reinstall the server.
+```sh  
+cargo check  
+cargo xtask install --server --code-bin code-insiders --dev-rel  
+```  
 
 Now on Visual Studio Code Insiders, we should be able to open the Output tab on our terminal and switch to Rust Analyzer Language Server to see the `eprintln!` statement we just wrote.