Clarify rust-analyzer binary install #4158
Conversation
docs/user/readme.adoc
Outdated
| You'll need Cargo, xtask, nodejs and npm for this. | ||
| Cargo-xtask can be found at https://github.com/matklad/cargo-xtask |
There was a problem hiding this comment.
The xtask binary is part of the rust-analyzer repository. It'll automatically build when calling cargo xtask from inside the rust-analyzer folder.
There was a problem hiding this comment.
Thanks for pointing that out. I changed it.
docs/user/readme.adoc
Outdated
|
|
||
| Other editors generally require the `rust-analyzer` binary to be in `$PATH`. | ||
| You can download the pre-built binary from the https://github.com/rust-analyzer/rust-analyzer/releases[releases] page. Typically, you then need to rename the binary for your platform, e.g. `rust-analyzer-mac` if you're on Mac OS, to `rust-analzyer` and make it executable in addition to moving it into a directory in your `$PATH`. | ||
|
|
||
| On Linux to install the `rust-analyzer` binary into `~/.cargo/bin` which usually is already added to `$PATH`, this commands could be used |
There was a problem hiding this comment.
I don't think putting binaries not installed by cargo into ~/.cargo/bin is a good idea.
There was a problem hiding this comment.
What fo you think is a better place?
There was a problem hiding this comment.
Maybe ~/.local/bin? There are a lot of programs that install themselves there. It isn't in PATH by default though.
There was a problem hiding this comment.
Thanks. I also think this is a better suggestion. I changed it.
because it's contained in the dart-analyzer repo.
instead of `~/.cargo/bin`
docs/user/readme.adoc
Outdated
| ---- | ||
|
|
||
| Ensure `~/cargo/bin` is listed in the `$PATH` variable. |
There was a problem hiding this comment.
| Ensure `~/cargo/bin` is listed in the `$PATH` variable. | |
| Ensure `~/local/bin` is listed in the `$PATH` variable. |
|
Thanks @zoechi ! bors r |
|
Build succeeded: |
No description provided.