From 18ba86b1c5e9b3d6288dd612ecd054f6386d529e Mon Sep 17 00:00:00 2001 From: Francisco Lopes Date: Mon, 4 May 2020 14:12:32 -0300 Subject: [manual] Improve requirements and editor wording --- docs/user/readme.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/user/readme.adoc') diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc index b1af72ce6..2c0a96a05 100644 --- a/docs/user/readme.adoc +++ b/docs/user/readme.adoc @@ -159,11 +159,11 @@ Emacs support is maintained as part of the https://github.com/emacs-lsp/lsp-mode 3. Run `lsp` in a Rust buffer. 4. (Optionally) bind commands like `lsp-rust-analyzer-join-lines`, `lsp-extend-selection` and `lsp-rust-analyzer-expand-macro` to keys. -=== Vim +=== Vim/NeoVim -Prerequisites: You have installed the <>. +Prerequisites: You have installed the <>. Not needed if the extension can install/update it on its own, coc-rust-analyzer is one example. -The are several LSP client implementations for vim: +The are several LSP client implementations for vim or neovim: ==== coc-rust-analyzer -- cgit v1.2.3 From bcc171737889038061ebf5714f71618f1a913bd3 Mon Sep 17 00:00:00 2001 From: Jacob Greenfield Date: Mon, 4 May 2020 13:16:29 -0400 Subject: Update server binary paths Fixed macOS path and converted to a list --- docs/user/readme.adoc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'docs/user/readme.adoc') diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc index b1af72ce6..29959ca72 100644 --- a/docs/user/readme.adoc +++ b/docs/user/readme.adoc @@ -57,7 +57,11 @@ To disable this notification put the following to `settings.json` ---- ==== -The server binary is stored in `~/.config/Code/User/globalStorage/matklad.rust-analyzer` (Linux) or in `~/.Library/Application Support/Code/User/globalStorage/matklad.rust-analyzer` (macOS) or in `%APPDATA%\Code\User\globalStorage` (Windows). +The server binary is stored in: + +* Linux: `~/.config/Code/User/globalStorage/matklad.rust-analyzer` +* macOS: `~/Library/Application Support/Code/User/globalStorage/matklad.rust-analyzer` +* Windows: `%APPDATA%\Code\User\globalStorage` Note that we only support the latest version of VS Code. -- cgit v1.2.3 From 2b06041692dcdbc1c49292fd64fdc67da312c1ca Mon Sep 17 00:00:00 2001 From: "Daniel M. Capella" Date: Tue, 5 May 2020 18:23:32 -0400 Subject: Update Arch Linux and ALE install instructions Package has been added to the Arch repos: https://www.archlinux.org/packages/community/x86_64/rust-analyzer/ ALE merged rust-analyzer support: https://github.com/dense-analysis/ale/commit/70005134e5b2d40d176ee5b851ac64a296b22201 --- docs/user/readme.adoc | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) (limited to 'docs/user/readme.adoc') diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc index 69f5b13d6..2f2b1d37a 100644 --- a/docs/user/readme.adoc +++ b/docs/user/readme.adoc @@ -139,17 +139,16 @@ If your editor can't find the binary even though the binary is on your `$PATH`, ==== Arch Linux -The `rust-analyzer` binary can be installed from AUR (Arch User Repository): +The `rust-analyzer` binary can be installed from the repos or AUR (Arch User Repository): -- https://aur.archlinux.org/packages/rust-analyzer-bin[`rust-analyzer-bin`] (binary from GitHub releases) -- https://aur.archlinux.org/packages/rust-analyzer[`rust-analyzer`] (built from latest tagged source) -- https://aur.archlinux.org/packages/rust-analyzer-git[`rust-analyzer-git`] (latest git version) +- https://www.archlinux.org/packages/community/x86_64/rust-analyzer/[`rust-analyzer`] (built from latest tagged source) +- https://aur.archlinux.org/packages/rust-analyzer-git[`rust-analyzer-git`] (latest Git version) -Install it with AUR helper of your choice, for example: +Install it with pacman, for example: [source,bash] ---- -$ yay -S rust-analyzer-bin +$ pacman -S rust-analyzer ---- === Emacs @@ -187,7 +186,7 @@ The are several LSP client implementations for vim or neovim: 1. Install LanguageClient-neovim by following the instructions https://github.com/autozimu/LanguageClient-neovim[here] - * The github project wiki has extra tips on configuration + * The GitHub project wiki has extra tips on configuration 2. Configure by adding this to your vim/neovim config file (replacing the existing Rust-specific line if it exists): + @@ -220,17 +219,11 @@ let g:ycm_language_server = ==== ALE -To add the LSP server to https://github.com/dense-analysis/ale[ale]: +To use the LSP server in https://github.com/dense-analysis/ale[ale]: [source,vim] ---- -call ale#linter#Define('rust', { -\ 'name': 'rust-analyzer', -\ 'lsp': 'stdio', -\ 'executable': 'rust-analyzer', -\ 'command': '%e', -\ 'project_root': '.', -\}) +let g:ale_linters = {'rust': ['analyzer']} ---- ==== nvim-lsp -- cgit v1.2.3 From e0b63855b1874ccc71a49c933f73c62c95a92d54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lauren=C8=9Biu=20Nicola?= Date: Wed, 6 May 2020 19:53:14 +0300 Subject: Fix Windows server path CC @Coder-256. --- docs/user/readme.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/user/readme.adoc') diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc index 69f5b13d6..301e9a49c 100644 --- a/docs/user/readme.adoc +++ b/docs/user/readme.adoc @@ -61,7 +61,7 @@ The server binary is stored in: * Linux: `~/.config/Code/User/globalStorage/matklad.rust-analyzer` * macOS: `~/Library/Application Support/Code/User/globalStorage/matklad.rust-analyzer` -* Windows: `%APPDATA%\Code\User\globalStorage` +* Windows: `%APPDATA%\Code\User\globalStorage\matklad.rust-analyzer` Note that we only support the latest version of VS Code. -- cgit v1.2.3 From 72e229fcb35f6056183f681e0d16c4fff8e5e381 Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Mon, 11 May 2020 19:14:12 +0200 Subject: Use RA_LOG instead of RUST_LOG for logging RUST_LOG might be set up for debugging the user's problem, slowing down rust-analyzer considerably. That's the same reason why rustc uses RUSTC_LOG. --- docs/user/readme.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/user/readme.adoc') diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc index f6ce0accf..d750c7705 100644 --- a/docs/user/readme.adoc +++ b/docs/user/readme.adoc @@ -108,7 +108,7 @@ Here are some useful self-diagnostic commands: * **Rust Analyzer: Show RA Version** shows the version of `rust-analyzer` binary * **Rust Analyzer: Status** prints some statistics about the server, like the few latest LSP requests -* To enable server-side logging, run with `env RUST_LOG=info` and see `Output > Rust Analyzer Language Server` in VS Code's panel. +* To enable server-side logging, run with `env RA_LOG=info` and see `Output > Rust Analyzer Language Server` in VS Code's panel. * To log all LSP requests, add `"rust-analyzer.trace.server": "verbose"` to the settings and look for `Server Trace` in the panel. * To enable client-side logging, add `"rust-analyzer.trace.extension": true` to the settings and open the `Console` tab of VS Code developer tools. -- cgit v1.2.3 From 19a8c1450c1fd7263b49e2e176f8fef0d93d923b Mon Sep 17 00:00:00 2001 From: Aleksey Kladov Date: Sun, 17 May 2020 15:57:30 +0200 Subject: Relax VS Code version requirement --- docs/user/readme.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/user/readme.adoc') diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc index d750c7705..03836e6e2 100644 --- a/docs/user/readme.adoc +++ b/docs/user/readme.adoc @@ -63,7 +63,7 @@ The server binary is stored in: * macOS: `~/Library/Application Support/Code/User/globalStorage/matklad.rust-analyzer` * Windows: `%APPDATA%\Code\User\globalStorage\matklad.rust-analyzer` -Note that we only support the latest version of VS Code. +Note that we only support two most recent versions of VS Code. ==== Updates -- cgit v1.2.3 From dfb931a4f1c39df7225db17e44e90cd192cd3d90 Mon Sep 17 00:00:00 2001 From: Alexandre Franke Date: Wed, 20 May 2020 20:11:14 +0200 Subject: Fix GNOME spelling GNOME is a trademark. :-) --- docs/user/readme.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/user/readme.adoc') diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc index 03836e6e2..40ed54809 100644 --- a/docs/user/readme.adoc +++ b/docs/user/readme.adoc @@ -249,7 +249,7 @@ If it worked, you should see "rust-analyzer, Line X, Column Y" on the left side If you get an error saying `No such file or directory: 'rust-analyzer'`, see the <> section on installing the language server binary. -=== Gnome Builder +=== GNOME Builder Prerequisites: You have installed the <>. -- cgit v1.2.3