New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to rustc guide #56079

Open
wants to merge 2 commits into
base: master
from

Conversation

Projects
None yet
6 participants
@mark-i-m
Contributor

mark-i-m commented Nov 19, 2018

As proposed in rust-lang/rustc-guide#239

@rust-highfive

This comment has been minimized.

Collaborator

rust-highfive commented Nov 19, 2018

r? @GuillaumeGomez

(rust_highfive has picked a reviewer for you, use r? to override)

@mark-i-m

This comment has been minimized.

Contributor

mark-i-m commented Nov 19, 2018

cc @gnzlbg

@gnzlbg

This comment has been minimized.

Contributor

gnzlbg commented Nov 20, 2018

@mark-i-m Thanks!

I would just call this the "Rust Compiler Guide" (at least in the title), we want to advertise this for people that might be interested in contributing, but not be familiar with rust, and they might not make the jump that rustc stands for "rust compiler".

Also, the Rust Compiler Guide explains, for example, how to build Rust from source, run the tests, install it in a location that can be picked by rustup, etc. This is not the focus of the guide, but this is very useful information for people that want to build Rust from source for whatever reason, e.g., because rustup does not support their platform, because they are packaging Rust for a linux distribution, etc.

It might well be that this group of people deserves their own guide (How to Build, Test, and Package Rust? :D), but in the meantime the Rust Compiler Guide is all we got, and I think it is worth it to emphasize that it also covers these things (it already mentions them, but it might be worth it to address these more directly somehow).

@mark-i-m

This comment has been minimized.

Contributor

mark-i-m commented Nov 20, 2018

I'm honestly a bit torn about the naming. There is also a "rustc book" linked in the same page. It is a user guide of how to use the compiler.

@gnzlbg

This comment has been minimized.

Contributor

gnzlbg commented Nov 20, 2018

Yeah, that's definitely confusing. Maybe "Rust Compiler User Guide" vs "Rust Compiler Developer Guide" ?

@steveklabnik

This comment has been minimized.

Member

steveklabnik commented Nov 20, 2018

This isn't ready to go yet; the plan is to uplift that repo as a submodule in this one, and then do this.

We also discussed the naming at the time. #49707

@gnzlbg

This comment has been minimized.

Contributor

gnzlbg commented Nov 20, 2018

@steveklabnik is there an open issue tracking that ? Adding the rustc book as a submodule is pretty straightforward, is there anything blocking this?

@mark-i-m

This comment has been minimized.

Contributor

mark-i-m commented Nov 20, 2018

Oh, yeah, I forgot about that.

Do we need to wait for it to become a submodule first?

@steveklabnik

This comment has been minimized.

Member

steveklabnik commented Nov 20, 2018

@steveklabnik is there an open issue tracking that ? Adding the rustc book as a submodule is pretty straightforward, is there anything blocking this?

There is no issue; the only think blocking it is @nikomatsakis saying that it's ready to go.

Do we need to wait for it to become a submodule first?

Yes.

@gnzlbg

This comment has been minimized.

Contributor

gnzlbg commented Nov 27, 2018

@nikomatsakis what do you think ? Is the rustc guide "good enough" to be linked in the docs website ? It's a bit hard to discover right now, and it contains information that's useful for non-rustc developers like how to build the Rust toolchain from source and test it etc.

@mark-i-m

This comment has been minimized.

Contributor

mark-i-m commented Nov 29, 2018

We now have a submodule :)

@Dylan-DPC

This comment has been minimized.

Member

Dylan-DPC commented Dec 10, 2018

ping from triage @nikomatsakis @steveklabnik any updates on this?

@steveklabnik

This comment has been minimized.

Member

steveklabnik commented Dec 10, 2018

r=me if @nikomatsakis agrees

thank you! sorry for the delay.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment