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.

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

Document Assemble in bootstrap #912

Merged
merged 1 commit into from
Oct 4, 2020
Merged

Document Assemble in bootstrap #912

merged 1 commit into from
Oct 4, 2020

Conversation

jyn514
Copy link
Member

@jyn514 jyn514 commented Oct 4, 2020

r? @Mark-Simulacrum
Follow-up to #857
Closes #911

@jyn514 jyn514 added the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Oct 4, 2020
@jyn514 jyn514 changed the title Document Assemble Document Assemble in bootstrap Oct 4, 2020
@Mark-Simulacrum
Copy link
Member

Hm, so I think this is good, but I'm not sure it belongs in general documentation like this.

I think it might be worth it to create two separate documents describing bootstrapping: one for users who want to understand what different flags etc do, and one for developers of bootstrap itself, who want to know about details like this. ISTM that whether we assemble the compiler or not is to some extent an implementation detail, not something I would expect us to document so prominently in general documentation.

Copy link
Member

@Mark-Simulacrum Mark-Simulacrum left a comment

Choose a reason for hiding this comment

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

That said, I feel this is somewhere in the middle on the "internal" vs "not" spectrum, so fine with me to merge it in the meantime.

@jyn514
Copy link
Member Author

jyn514 commented Oct 4, 2020

So, this is something I've been wanting to bring up for a while - although in an ideal world you wouldn't have to know about bootstrap internals, in practice you have to. If we don't document Assemble, then it makes no sense that x.py build --stage 0 compiler/rustc doesn't create stage1/rustc; it just seems like a bug. It's a leaky abstraction.

@Mark-Simulacrum
Copy link
Member

Hm, I think I disagree that you "in practice have to." (Bugs aside, of which there are not too many, and we're fixing them over time).

The bug there seems fixable -- I would be happy to take a PR or it can get added to the (endless) list of things I need to look at :) But for now yes we can merge this to improve docs while the bug exists.

@jyn514
Copy link
Member Author

jyn514 commented Oct 4, 2020

Sounds good to me :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Explain what Assemble does in bootstrap
2 participants