[Draft] Rework the "Overview of the Compiler" chapter #1955
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Nadrieril
reviewed
Apr 1, 2024
src/overview/overview.md
Outdated
Comment on lines
377
to
379
| > 🚧 **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
Nadrieril
reviewed
Apr 1, 2024
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
Nadrieril
reviewed
Apr 1, 2024
Nadrieril
reviewed
Apr 1, 2024
- 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.