Skip to content
This repository has been archived by the owner on Dec 8, 2020. It is now read-only.

Describe how to install the Rust Language Server #94

Merged
merged 6 commits into from
Feb 20, 2017

Conversation

torkleyy
Copy link
Contributor

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 h2s.

@KalitaAlexey
Copy link
Member

Hello @torkleyy,
Thank you for your assistance.
I don't like your changes.
You insist on using rustup.
I will think about how we can describe all ways of installation.

@KalitaAlexey
Copy link
Member

@torkleyy,
If you want to help, please describe all ways to use RLS:

  • Use installed RLS (via cargo install)
  • Use RLS from source with rustup
  • Use RLS from source with nightly compiler

@KalitaAlexey
Copy link
Member

@torkleyy,
Will you do that or should I do that myself?

@torkleyy
Copy link
Contributor Author

@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:
Copy link
Contributor

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.

Copy link
Member

@KalitaAlexey KalitaAlexey left a 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:
Copy link
Member

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
Copy link
Member

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.

Copy link
Contributor

@redactedscribe redactedscribe Feb 19, 2017

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.

Copy link
Member

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.

Copy link
Contributor

@redactedscribe redactedscribe Feb 19, 2017

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.

Copy link
Member

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.
Copy link
Member

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?

Copy link
Contributor

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.

Copy link
Member

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.

Copy link
Contributor Author

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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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.
Copy link
Member

@KalitaAlexey KalitaAlexey Feb 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@redactedscribe,
It should be:

You should only do this only if ...

shouldn't it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KalitaAlexey Sounds better, yes.

Copy link
Contributor

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.

@KalitaAlexey
Copy link
Member

Hello @torkleyy,
Will you have time today?
I think I can wait with publishing a new version of the extension until the PR is merged.

@torkleyy
Copy link
Contributor Author

@KalitaAlexey I do, but I thought we would wait for @nrc to tell us whether one should use rustup to install thr RLS.

@KalitaAlexey
Copy link
Member

@torkleyy,
We shouldn't wait.
It doesn't change anything because the documentation would describe both cases (with/without rustup).
I suppose the RLS's README means the problem with analysis directory:

Note that if you change Rust installation (e.g., using rustup), your sysroot might change.

@torkleyy
Copy link
Contributor Author

If I missed something, I'll be online in 10 hours again

@KalitaAlexey
Copy link
Member

Everything is fine, but there are conflicts.
I don't know how I can fix them myself, so I will be waiting for you.

@torkleyy
Copy link
Contributor Author

@KalitaAlexey It's because you renamed rls_mode.md. But I'm not sure how to resolve a rename. I'll try in 3 hours. Also, should I add a link to the new linting page?

@torkleyy
Copy link
Contributor Author

@KalitaAlexey You should be able to merge it now (finally).

@KalitaAlexey
Copy link
Member

Which new linting page you are talking about?

@torkleyy
Copy link
Contributor Author

This one

@KalitaAlexey
Copy link
Member

You shouldn't.

@KalitaAlexey KalitaAlexey merged commit c88c065 into editor-rs:master Feb 20, 2017
@torkleyy torkleyy deleted the patch-1 branch February 20, 2017 15:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants