Readme update: RUST_SRC_PATH not mandatory anymore #863
Conversation
README.md
Outdated
|
|
||
| (e.g. ```% export RUST_SRC_PATH=/usr/local/src/rust/src``` or ```% export RUST_SRC_PATH="$(rustc --print sysroot)/lib/rustlib/src/rust/src"``` ) | ||
|
|
||
|
|
||
| This is not mandatory anymore to use `racer`. |
There was a problem hiding this comment.
This is not mandatory anymore to use
racer.
I think we don't need this sentence.
Or, It's better 'If you downloaded Rust sourcecode using rustup, this process is not necessary'.
README.md
Outdated
| @@ -36,10 +36,14 @@ As mentioned in the command output, don't forget to add the installation directo | |||
|
|
|||
| 2. manually from git, or download from https://www.rust-lang.org/install.html (the 'rustc' source download behind the 'source' link is the right one). | |||
There was a problem hiding this comment.
Now we can't install source from https://www.rust-lang.org/install.html, so could you please modify this sentence to just 'manually from git' ?
README.md
Outdated
| @@ -36,10 +36,14 @@ As mentioned in the command output, don't forget to add the installation directo | |||
|
|
|||
| 2. manually from git, or download from https://www.rust-lang.org/install.html (the 'rustc' source download behind the 'source' link is the right one). | |||
|
|
|||
| 2. Set the ```RUST_SRC_PATH``` environment variable to point to the 'src' dir in the Rust source installation | |||
| Ensure to download sources for any rust version you have installed (e.g. a common configuration is to have the `stable` and many `nightly` installed). | |||
There was a problem hiding this comment.
to have the
stableand manynightlyinstalled
Hmm... I don't understand what you mean here.
But, I'm not a native English speaker so I'm not sure.
There was a problem hiding this comment.
neither am I :-) what I tried to explain here is perphaps redundant; imagine the following workflow:
- user downloads stable rust using
rustup - user downloads sources and installs
racer - at some point in the future, user downloads a nightly build because (f.e.) they want to use Rocket
racerpartially stops working because user forgot to also download the nightly build sources
(just happened to me yesterday)
Do you think it's worth such a note or it ends up being more confusing? Any suggestion on how to rephrase more clearly? e.g. simply with Remember to download sources after installing a nightly build too.
Or better: "Remember to run rustup component add rust-src also after installing a nightly build."
There was a problem hiding this comment.
Ah I understand, thanks.
Then my suggestion is:
Note
If you want to use racer with multiple release channels(we can use 3 release channels, stable, beta and nightly), you have to download Rust sourcecode for each relase channels.
e.g.(rustup case)
You have to run rustup component add rust-src after rustup toolchain add nightly.
|
Thanks! |
Hello,
as briefly discussed here the env var
RUST_SRC_PATHis to not mandatory anymore.If this env var is actually not really needed, could it be useful to relax the configuration requirements for
racer? Possibly this may lead to a couple ofracerissue disappearing (not really sure about this, haven't investigated really closely).And how about removing mentioning this env var altogether to simplify the config process?
Feel free to suggest on how to improve this little doc update or OTOH is not really needed and can be yanked.
Thanks!