[Draft] Rework the "Overview of the Compiler" chapter #1955
Conversation
src/overview/overview.md
Outdated
| > 🚧 **TODO** 🚧 (Remove the cat meme when complete with draft) | ||
|
|
||
|  |
There was a problem hiding this comment.
🤣 plz don't remove the cat meme
There was a problem hiding this comment.
something something retaining the cat meme might require an FCP in the final version /jk
src/overview/overview.md
Outdated
| > trait system here?** AFAIK, it's both dependent and and provides information | ||
| > to multiple areas. Link: <https://github.com/rust-lang/rust/pull/121848> | ||
|
|
||
| #### Static-Single Assignment (SSA) Code Generation |
There was a problem hiding this comment.
You're missing a section about codegen. Idk if it's querified or not
There was a problem hiding this comment.
We don't talk about codegen Yeah I'm not completely sure about codegen atm.
There was a problem hiding this comment.
Stubbed out a section on the 3 codegen backends
- Transfer everything from HackMD into a PR.
- Change querified area summary order to correspond to "normal" code->codegen direction. - Add SVGs generated based on the graphviz sources. - Remove some editorial remarks.
jieyouxu
force-pushed
the
overview-rework
branch
from
fbeee80 to
73a402b
Compare
…en backends - Extend HIR wfcheck to cover not only type wfcheck, but other HIR wfchecks like object safety. - Stub out rustc driver/interface as the high-level entry point and orchestrator of the compilation process. - Stub out codegen backends.
|
@jieyouxu meow (do you plan to continue working on this at some point) |
yes meow |
jieyouxu
added
the
S-waiting-on-author
|
I'm closing this PR because I think I have a better idea for how to organize the overview and I didn't really vibe with this organization (of information dependency flow, I still find it confusing myself). I want to talk about it in the reading club and w/ t-compiler ppl ~next week. (And it's easier to start from a fresh plate.) |
jieyouxu
removed
the
S-waiting-on-author
Context: #674
Reworking the "Overview of the Compiler" chapter
I've noticed that the current Overview chapter seems to have several issues that make it difficult for new contributors to understand the compiler's structure and architecture at a high-level:
See also discussion during a rustc-dev-guide reading club session (cf. https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-rustc-dev-guide/topic/.5Breading.20club.5D.202023.2E02.2E26.20chapters.2022.20to.2030/near/423423778).
This PR aims to rework the Overview of the Compiler chapter to make it more friendly for new contributors and be more comprehensive and to address some of these shortcomings.
The R0 draft here is intentionally incomplete: I worked on this draft in a separate HackMD document, but it's at a point where it has sufficient content to allow people to start giving feedback, suggestions and contributions (and I also want to start fixing the links and reworking diagrams so they can be embedded in a mdBook-compatible fashion).
Some inline remarks (presented as quote blocks) are left in during draft phase, will be removed when ready.
Rendered text
Revision History
Revision history is maintained through individual commits, so they are not repeated here.