-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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
Add "the Rustc book" #49707
Add "the Rustc book" #49707
Conversation
I wouldn't have expected there to be enough material to cover in a special rustc-the-compiler book that doesn't already belong in the Rust-the-language book? |
@zackmdavis tons and tons of stuff. we only mention |
How about
|
Also, do you have a time line for when you want to do that? (cc #48478) |
That's more up to them than to me, whenever they're comfy doing so, I'm happy to make it happen! |
Your PR failed on Travis. Through arcane magic we have determined that the following fragments from the build log may contain information about the problem. Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
Your PR failed on Travis. Through arcane magic we have determined that the following fragments from the build log may contain information about the problem. Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
|
||
## `--error-format`: control how errors are produced | ||
|
||
## `--color`: configur coloring of output |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo: configure
Your PR failed on Travis. Through arcane magic we have determined that the following fragments from the build log may contain information about the problem. Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
☔ The latest upstream changes (presumably #49753) made this pull request unmergeable. Please resolve the merge conflicts. |
I believe the rustc lint documentation would partly resolve #49416 as well 👍 |
I think that the naming of "Rustc contributor guide" feels pretty ok. It doesn't sound quite as "weighy" as it might -- like it sounds sort of like "CONTRIBUTING.md" to me -- but then again once you open it, you'll see what it is. And certainly it contains material that would ordinarily be covered by a typical CONTRIBUTING.md -- that is, I envision it being the "one stop shop" for people who want to hack on rustc. cc @mark-i-m, who may have an opinion here |
Oh I see @mark-i-m already commented :) d'oh |
How about "Rustc Hackers Guide"? |
"Internals" doesn't really strike me as "how rustc works" somehow... It's not really what I would google if I was looking for it. I've also thought about longer titles, like "How rustc works and how to contribute to it" |
Updated to fix nits. @illustrious-you i like it! |
Official documentation from other open-source projects often refers to "internals": While there is no standard for this kind of documentation, there is a norm.
Huh. When I'm looking for a conceptual overview, it's my go-to term. I'm not sure where I picked that habit up, but it tends to produce reliable results*:
It's notable, however, that you said it's not the first thing you'd search for Rust, and the search results seem to bear that out: Google, Bing. Instead of finding articles about Rust internals, the search engines find the internals boards. * Note: to avoid biasing results with your search history, open the links in a private browser session. |
Unless anyone has any major follow up issues, i'm ready to call this good! Little things can go in as PRs after this lands. @bors r+ |
📌 Commit 36475d9 has been approved by |
⌛ Testing commit 36475d9 with merge 4af44e06ec54a5f3f3e8152c2ce0c861be88209b... |
💔 Test failed - status-travis |
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
1 similar comment
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
Spurious failure compiling @bors: retry |
@bors rollup |
…dreavus Add "the Rustc book" This PR introduces a new book into the documentation, "The rustc book". We already have books for Cargo, and for Rustdoc, rustc should have some too. This book is focused on *users* of rustc, and provides a nice place to write documentation for users. I haven't put content here, but plan on scaffolding it out very soon, and wanted this PR open for a few discussions first. One of those is "what exactly should said TOC be?" I plan on having a proposed one up tomorrow, but figured I'd let people know to start thinking about it now. The big one is that we also will want to put https://github.com/rust-lang-nursery/rustc-guide in-tree as well, and the naming is... tough. I'm proposing: * doc.rust-lang.org/rustc is "The Rustc book", to mirror the other tools' books. * doc.rust-lang.org/rustc-contribution is "The Rustc contribution guide", and contains that book @nikomatsakis et al, any thoughts on this? I'm not attached to it in particular, but had to put something together to get this discussion going. I think mirroring the other tools is a good idea for this work, but am not sure where exactly that leaves yours. Fixes rust-docs/team#11
Rollup of 7 pull requests Successful merges: - #49707 (Add "the Rustc book") - #50222 (Bump bootstrap compiler to 2018-04-24) - #50227 (Fix ICE with erroneous `impl Trait` in a trait impl) - #50229 (Add setting to go to item if there is only one result) - #50231 (Add more doc aliases) - #50246 (Make dump_{alloc,allocs,local}() no-ops when tracing is disabled.) - #49894 (Rename InternedString to LocalInternedString and introduce a new thread-safe InternedString) Failed merges:
This PR introduces a new book into the documentation, "The rustc book". We already have books for Cargo, and for Rustdoc, rustc should have some too. This book is focused on users of rustc, and provides a nice place to write documentation for users.
I haven't put content here, but plan on scaffolding it out very soon, and wanted this PR open for a few discussions first. One of those is "what exactly should said TOC be?" I plan on having a proposed one up tomorrow, but figured I'd let people know to start thinking about it now.
The big one is that we also will want to put https://github.com/rust-lang-nursery/rustc-guide in-tree as well, and the naming is... tough. I'm proposing:
@nikomatsakis et al, any thoughts on this? I'm not attached to it in particular, but had to put something together to get this discussion going. I think mirroring the other tools is a good idea for this work, but am not sure where exactly that leaves yours.
Fixes rust-docs/team#11