diff options
| author | bors <bors@rust-lang.org> | 2022-10-10 17:03:44 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2022-10-10 17:03:44 +0000 |
| commit | 43c7f3ca3d1828f67d65d705b30eba21ec1485e9 (patch) | |
| tree | bdf14db2d72856cfc0c16f2aefdf120572e5c442 | |
| parent | d23537394e92e1abc864dc4cabdab14ad9b9c0c1 (diff) | |
| parent | 76be44eed5e0fe1a80d642a31a4f0537e151f7fe (diff) | |
| download | rust-43c7f3ca3d1828f67d65d705b30eba21ec1485e9.tar.gz rust-43c7f3ca3d1828f67d65d705b30eba21ec1485e9.zip | |
Auto merge of #13391 - dvdsk:update-manual, r=lnicola
Update manual now stable can be installed with rustup this a new PR for #13374 as `bors squash` seemed to have broken `bors` _______ `rustup` can now install `rust-analyzer` for the stable tool-chain. This commit removes the note that `rustup` can only install for the nightly branch and adjusts the command. I also added a note on how to find the path to the `rust-analyzer` binary when installed using `rustup`, and suggestions on how to work around it not being placed in `~/.cargo/bin`. I thought it would be ideal to point everyone to use `rustup run stable rust-analyzer` to start `rust-analyzer`. That would make it trivial to switch to nightly however I could not get this to work in `nvim` therefore I left it as a suggestion at the end.
| -rw-r--r-- | docs/user/manual.adoc | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index 9bd3b6a692b..c30838e5f5e 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc @@ -174,14 +174,25 @@ On Unix, running the editor from a shell or changing the `.desktop` file to set ==== `rustup` -`rust-analyzer` is available in `rustup`, but only in the nightly toolchain: +`rust-analyzer` is available in `rustup`: [source,bash] ---- -$ rustup +nightly component add rust-analyzer-preview +$ rustup component add rust-analyzer ---- -However, in contrast to `component add clippy` or `component add rustfmt`, this does not actually place a `rust-analyzer` binary in `~/.cargo/bin`, see https://github.com/rust-lang/rustup/issues/2411[this issue]. +However, in contrast to `component add clippy` or `component add rustfmt`, this does not actually place a `rust-analyzer` binary in `~/.cargo/bin`, see https://github.com/rust-lang/rustup/issues/2411[this issue]. You can find the path to the binary using: +[source,bash] +---- +$ rustup which --toolchain stable rust-analyzer +---- +You can link to there from `~/.cargo/bin` or configure your editor to use the full path. + +Alternatively you might be able to configure your editor to start `rust-analyzer` using the command: +[source,bash] +---- +$ rustup run stable rust-analyzer +---- ==== Arch Linux |