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 overview.drawio.svg #1725

Open
wants to merge 2,121 commits into
base: master
Choose a base branch
from
Open

Add overview.drawio.svg #1725

wants to merge 2,121 commits into from

Conversation

sslime336
Copy link
Contributor

draw.io: https://www.drawio.com/

I used to do some notes using these kind of files, they are easy to use and their size is affordable. Since I haven't seen such graphs about the rustc, I did this myself hoping it could be a help for anyone who wants to get to know the arch of the rustc and its workflow.

Currently I've just placed it in src/drawio/overview.drawio as I think this might be a good place to store such kind of files.

You can edit *.drawio by VSCode extension or online:

图片

I'm new to rustc so the overview.drawio might not be entirely correct, and I wish that someone could fix it or add more info about the rustc :-)

lcnr and others added 30 commits October 22, 2022 19:53
@lcnr @JohnTitor
fix some links (rust-lang#1490)
736fcb9 
Co-authored-by: Yuki Okushi <[email protected]>
@luqmana
miri is no longer a submodule but a subtree. (rust-lang#1488)
0a2f713
@Veykril
Update rust-analyzer suggestions (rust-lang#1487)
a262476
@Noratrieb @davidtwco
Update diagnostics to flat fluent message paths
6686b1e 
As implemented in rust-lang/rust#103345
@compiler-errors @spastorino
Update traits/resolution.md (rust-lang#1494)
51a37ad 
* Update `traits/resolution.md`

Co-authored by: @lcnr and @spastorino

* Update src/traits/resolution.md

* Wrapping

* Update src/traits/resolution.md

Co-authored-by: Santiago Pastorino <[email protected]>

Co-authored-by: Santiago Pastorino <[email protected]>
@ehuss @tshepang
Update for highfive transition.
7f426da
@ChrisDenton @tshepang
Remove --bless from pre-push hook suggestion
bd8eeff 
According to rust-lang/rust@8873e33

> Running with --bless causes the push to succeed if there are fixable
formatting changes, but the changes don't make it into the push.
>
> We should have the user rerun with --bless (or x.py fmt) and commit the
changes themselves (they might want to amend a particular commit, for
instance).
@Rageking8 @tshepang
add note for err annotation formatting
88bd6ca
@spastorino
trans -> codegen (rust-lang#1500)
94ecbac
@JhonnyBillM @davidtwco
UPDATE - mention of Diagnostic derive on enums
03fe2d4 
Updated Diagnostic text to use the same language used in Subdiagnostic
@jonathanCogan @pierwill
Fixes some typos (rust-lang#1502)
a6c35fc 
* Fix some typos.

Co-authored-by: pierwill <[email protected]>
@tshepang
align code blocks with their paragraphs
43e4117
@tshepang
replace tabs with spaces (rust-lang#1504)
2bdb02c
@Noratrieb @jyn514
Update query.md
0872241 
- queries always need a description
- `QueryDescription` isn't just for descriptions (it's actually not for
  descriptions at all now) and always implemented by the macro
- queries are not grouped into categories
@Noratrieb @jyn514
Update some more things and improve wording
090bd54
@Noratrieb @jyn514
Remove implementation details
63b45c3
@lcnr @tshepang
trans -> codegen
d0dc6c9
@Xiretza
Document multiple alternative suggestions on diagnostic structs (rust…
01a51b2 
…-lang#1486)
@RCoder01 @tshepang
Consistent ordered list indexing
7354b42
@lcnr @tshepang
extract regions
39c10de
@lcnr @tshepang
Update src/type-inference.md
36e15ae 
Co-authored-by: Tshepang Mbambo <[email protected]>
@tshepang
date-check: updating-llvm (rust-lang#1424)
6f3d5e4
@tshepang @JohnTitor
updating-llvm: keep a calm tone (rust-lang#1449)
f98f1e5 
Co-authored-by: Yuki Okushi <[email protected]>
@JohnTitor @tshepang
Fix a broken design docs link about unused substs bug
32bc13e 
rust-lang/project-const-generics#21 removed the
link. This replaces it with an issue link mentioned on the design docs.

Signed-off-by: Yuki Okushi <[email protected]>
@ghassanachi @tshepang
Update path for try_mark_green implementation
0bd5bd1 
Updates the location of the `try_mark_green` algorithm from `compiler/rustc_middle/src/dep_graph/graph.rs` to [`compiler/rustc_middle/src/dep_graph/graph.rs`](https://github.com/rust-lang/rust/blob/stable/compiler/rustc_query_system/src/dep_graph/graph.rs#L574) .
@camelid
Triage some date-check items (rust-lang#1513)
2889c29
@tshepang @camelid
do an actual link to detect if it breaks in future (rust-lang#1517)
e85c4c4 
Co-authored-by: Noah Lev <[email protected]>
@jyn514 @camelid
Link directly to the section on --keep-stage
af134d2
@jyn514 @camelid
Don't use "incremental" to refer to --keep-stage
fa3ffbf 
`-C incremental` is sound and --keep-stage is not.
@jyn514 @camelid
Fix broken link
96462f2 
Co-authored-by: Noah Lev <[email protected]>
jyn514 and others added 19 commits June 29, 2023 10:05
@jyn514
Inline alternate x.py invocations from the rust-lang/rust readme
1690634 
I'm going to make a follow-up PR shortly linking from rust-lang/rust to the dev guide so this info isn't duplicated.
@jyn514
Improve Windows docs
c8213e1
@jyn514 @tshepang
include rustc-dev-guide's own issues in suggested search
7267158
@sslime336 @tshepang
Change ./x.py into ./x
d3034ae
@sslime336 @tshepang
Change x.py into x, add explanation for x
50dbcba
@sslime336 @tshepang
Fix line length out of limit
37ffa30
@tshepang
typo
8648005
@sslime336 @tshepang
Try to avoid confusion
07f16bb
@tshepang
OwningRef exists no more
605c35a
@tshepang @compiler-errors
typo
07c92b8
@tshepang
update link
49b868e
@tshepang @compiler-errors
fix link
68967d7
@tshepang
replace dead link (rust-lang#1717)
a0f596f
@tshepang
tests/run-make files have moved
e592090
@lqd @tshepang
document .x test --rustc-args option
95ce237
@tshepang
ty::ConstKind has moved (rust-lang#1724)
0658909
@tshepang
various fixes/improvements to Contributing chapter (rust-lang#1723)
6d5b3db
@tshepang @JohnTitor
improve explanation of placing tests in separate file (rust-lang#1721)
b10654a 
Co-authored-by: Yuki Okushi <[email protected]>
@sslime336
Add overview.drawio
063875f
@TaKO8Ki
Copy link
Member

TaKO8Ki commented Jul 10, 2023 •
edited
Loading

I think it's better to convert this file to something like .drawio.svg. By doing so, we can view the diagram on GitHub. The SVG file is editable on draw.io and can be embedded on Github.

ref:

@sslime336
Copy link
Contributor Author

Cool, first time knowing that, thanks :-)

@sslime336 sslime336 changed the title Add overview.drawio Add overview.drawio.svg Jul 10, 2023
@jieyouxu jieyouxu added the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Oct 8, 2024
@jieyouxu jieyouxu mentioned this pull request Nov 4, 2024
Open
5 tasks
@jieyouxu jieyouxu added T-compiler Relevant to compiler team A-compiler-architecture Area: high-level compiler architecture A-visualizations Area: visualizations labels Nov 4, 2024
@Kobzol
Copy link
Contributor

Kobzol commented Jan 5, 2025

Sorry, due to me messing up a git operation, we sadly had to force-push the whole commit history of rustc-dev-guide :( If you'd like to update this pull request, you will have to rebase it in a special way onto the new commit history (the new master):

git fetch origin --all
git checkout <pr-branch>
git rebase --onto origin/master origin/master-old
git push --force-with-lease

More context can be found here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
A-compiler-architecture Area: high-level compiler architecture A-visualizations Area: visualizations S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content T-compiler Relevant to compiler team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.