Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add information on how to run builds to CONTRIBUTING.md #42484

Closed
jrmuizel opened this issue Jun 6, 2017 · 2 comments · Fixed by #44194
Closed

Add information on how to run builds to CONTRIBUTING.md #42484

jrmuizel opened this issue Jun 6, 2017 · 2 comments · Fixed by #44194
Assignees
@QuietMisdreavus
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. P-high High priority T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Comments

@jrmuizel
Copy link
Contributor

jrmuizel commented Jun 6, 2017

CONTRIBUTING.md talks about producing builds but not how to use them. i.e. do they need to packaged and installed someplace? Where is this? How do use multiple ones at the same time? etc.
@Mark-Simulacrum Mark-Simulacrum added C-enhancement Category: An issue proposing an enhancement or a PR with one. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) and removed A-build labels Jul 27, 2017
@steveklabnik steveklabnik added the P-medium Medium priority label Aug 30, 2017
@steveklabnik steveklabnik added P-high High priority and removed P-medium Medium priority labels Aug 30, 2017
@QuietMisdreavus
Copy link
Member

So right now, the CONTRIBUTING.md includes a little note about rustup toolchain link <name> build/<host-triple>/<stage>, including a link to a section in the rustup readme about the linked toolchain feature. I'll take the opportunity to expand the note into its own section, though.

QuietMisdreavus added a commit to QuietMisdreavus/rust that referenced this issue Aug 30, 2017
@QuietMisdreavus
expand on using rustup custom toolchains in CONTRIBUTING.md
1615d35 
fixes rust-lang#42484
@QuietMisdreavus QuietMisdreavus mentioned this issue Aug 30, 2017
Merged
@QuietMisdreavus
Copy link
Member

I've opened up #44194 to expand the rustup note into its own section.

bors added a commit that referenced this issue Sep 4, 2017
@bors
Auto merge of #44194 - QuietMisdreavus:hey-how-do-i-use-this-new-fang…
088216f 
…led-thing, r=aturon

expand on using rustup custom toolchains in CONTRIBUTING.md

fixes #42484

Should i include more notes about how to use a local build *without* rustup? It can kinda feel like a cop-out otherwise. Other means that come to mind are setting `$RUSTC` directly and fully installing it.

cc @rust-lang/docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@QuietMisdreavus QuietMisdreavus

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. P-high High priority T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

expand on using rustup custom toolchains in CONTRIBUTING.md QuietMisdreavus/rust
4 participants
@steveklabnik @jrmuizel @Mark-Simulacrum @QuietMisdreavus