-
Notifications
You must be signed in to change notification settings - Fork 62
Describe how to install the Rust Language Server #94
Conversation
Hello @torkleyy, |
@torkleyy,
|
@torkleyy, |
@KalitaAlexey Sorry, I didn't have time yesterday. I'll do it now |
Add how to install RLS with and without rustup and moved the debugging configuration to the "Debugging" section
doc/rls_mode.md
Outdated
|
||
Make sure you do have [rustup](https://github.com/rust-lang-nursery/rustup.rs) with nightly toolchain. | ||
|
||
Because at the moment RLS links to the compiler and it assumes the compiler to be globally installed, one can only run the RLS from sources. To use the nightly compiler, we pass `+nightly` to rustup's cargo proxy: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Another option is rustup run nightly rls
to invoke installed RLS.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@torkleyy,
I am sorry for that, but I have changed my mind.
I asked you to write the instruction for not rustup, but I want you to remove it.
That is because rustup is the most recommended and preferred way to install Rust.
doc/rls_mode.md
Outdated
|
||
There is an output channel named "Rust Language Server" which is used to show messages from RLS. | ||
First of all, you have to download the RLS sourcs: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make RLS be a link.
Typo: sourcs.
doc/rls_mode.md
Outdated
* [Setting up without rustup](#without-rustup) | ||
* [Setting up with rustup](#with-rustup) | ||
|
||
#### Without rustup |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the whole section.
Read motivation in the review comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Leaving these instructions in place might be useful to some people. The RLS repository recommended avoiding rustup
as it has caused problems in the past, though this may be outdated information now.
If rustup
is the recommended method now, I think that it should be pointed out. Also, the "Setting up with rustup" section should then be listed first in my opinion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@redactedscribe,
I haven't heard about problems with RLS and rustup.
I suppose I can be wrong.
Let's keep the section then.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/rust-lang-nursery/rls#building
Note, I have not successfully installed RLS myself as I have compilation issues that I am trying to solve.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@redactedscribe,
It is not an issue anymore.
@nrc @jonathandturner,
Could you provide more information in this?
I use RLS with rustup and doesn't experience any issues.
doc/rls_mode.md
Outdated
|
||
#### With rustup | ||
|
||
Make sure you do have [rustup](https://github.com/rust-lang-nursery/rustup.rs) with nightly toolchain. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the do word here for emphasis?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would suggest:
Make sure you have [rustup](https://github.com/rust-lang-nursery/rustup.rs) set to use the nightly toolchain.
Does it matter which nightly toolchain architecture one uses? i686/x86_64.
Should the command be given to achieve this? rustup default nightly-x86_64
for example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@redactedscribe,
It doesn't matter which architecture nightly is used for.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@KalitaAlexey Yes, it is. I used it because the section says "With rustup" and most people following that section will already have it. If it should only be described how to do that with rustup, I'll change that anyway.
doc/rls_mode.md
Outdated
|
||
Make sure you do have [rustup](https://github.com/rust-lang-nursery/rustup.rs) with nightly toolchain. | ||
|
||
If you want to install rls globally, just do |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggestion:
You can use RLS which either installed or running from the source code.
If you want use RLS installed, but RLS hasn't been installed yet, perform the following steps in order to install RLS:
doc/rls_mode.md
Outdated
If you want to install rls globally, just do | ||
|
||
```bash | ||
cargo install |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before the line should be cd /path/to/RLS/source
.
doc/rls_mode.md
Outdated
|
||
#### RLS is installed | ||
You can now install the Rust Language Server globally with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Describe that cargo install
should be executed in the directory of RLS's source.
doc/rls_mode.md
Outdated
|
||
For making RLS print more data, refer the "Debug RLS" section below. | ||
**Note:** You should only do this if you do not have rustup because otherwise rustup will not work anymore. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@KalitaAlexey Sounds better, yes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Both are acceptable, though I think your suggestion is nicer. I am not an expert on some of the more technical rules of English, though I know the basics well.
Hello @torkleyy, |
@KalitaAlexey I do, but I thought we would wait for @nrc to tell us whether one should use rustup to install thr RLS. |
@torkleyy,
|
If I missed something, I'll be online in 10 hours again |
Everything is fine, but there are conflicts. |
@KalitaAlexey It's because you renamed |
@KalitaAlexey You should be able to merge it now (finally). |
Which new linting page you are talking about? |
This one |
You shouldn't. |
I think this makes it easier to use the RLS mode of this plugin.
Additionally, I've changed the other sections ("Debugging" and "Examples") to
h2
s.