Improve documentation of MIR queries & passes #1434

Jaic1 · 2022-08-16T11:32:22Z

This PR improve the documentation of MIR queries and passes.

Below is the summary of changes:

delete mir_validated
add mir_promoted and mir_drops_elaborated_and_const_checked
replace the NoLandingPads pass example with CleanupNonCodegenStatements
extend the stealing mechanism and give the dependency of MIR queries as an overview
add mdbook-mermaid in the build instructions

FIXME:

Does ty::queries::foo::force(...) still appear in rustc?

Since rust-lang/rust#99102 may significantly change the MIR queries (and thus its doc), we can wait for its result or send follow-up PRs. This is mostly documenting the code in rustc_mir_transform, so maybe cc @rust-lang/wg-mir-opt.

src/mir/passes.md

tshepang · 2022-08-31T05:27:04Z

with rust-lang/rust#99102 now accepted, does this need to change

Jaic1 · 2022-09-05T06:51:39Z

Yes, the doc in this PR need to change to reflect the recent changes in rust-lang/rust#99102. But we could wait a minute until it gets more stable and complete since the MIR phases and semantics there, I think, are under overhaul.

jyn514 · 2023-01-01T00:25:59Z

rust-lang/rust#99102 has been merged :)

JohnTitor · 2023-02-09T10:14:05Z

@oli-obk Could you help with the review here or ping relevant folks?
@Jaic1 Could you resolve the merge conflict meanwhile?

src/mir/passes.md

oli-obk · 2023-02-09T13:43:13Z

cc @JakobDegen

spastorino · 2023-10-26T14:21:22Z

I'm not sure what's the current status of this PR, but would be great if we merge something about it, thoughts?.

Jaic1 · 2024-06-30T03:07:49Z

Sorry for the late reply, I had been busy with my master project for the last few years.

I just refined the MIR passes doc and resolved the git conflicts.

Jaic1 · 2024-06-30T03:10:04Z

cc @spastorino, could you help me find some reviewers?

oli-obk · 2024-07-09T08:06:15Z

Please rebase so there are no more merge commits

accidently -> accidentally Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>

Jaic1 · 2024-07-10T05:53:05Z

Please rebase so there are no more merge commits

Done.

spastorino

Looks good to me but I'd leave the merge up to @oli-obk who knows better about MIR than me.

Update books ## rust-lang/book 3 commits in f1e49bf7a8ea6c31ce016a52b8a4f6e1ffcfbc64..67fa536768013d9d5a13f3a06790521d511ef711 2024-07-12 21:21:45 UTC to 2024-07-05 17:35:06 UTC - Use Rust 2021 Edition for mdBook (rust-lang/book#3974) - Backport changes to chapter 11 (rust-lang/book#3969) - Upgrade to Rust 1.79.0 (rust-lang/book#3968) ## rust-lang/edition-guide 2 commits in 941db8b3df45fd46cd87b50a5c86714b91dcde9c..5454de3d12b9ccc6375b629cf7ccda8264640aac 2024-07-14 07:06:34 UTC to 2024-07-12 06:05:29 UTC - Update timeline etc. for Rust 2024 - 2024: Add note about never_type_fallback_flowing_into_unsafe lint level. (rust-lang/edition-guide#311) ## rust-embedded/book 1 commits in b10c6acaf0f43481f6600e95d4b5013446e29f7a..019f3928d8b939ec71b63722dcc2e46330156441 2024-07-11 17:46:10 UTC to 2024-07-11 17:46:10 UTC - typo on tooling.md (rust-embedded/book#373) ## rust-lang/reference 9 commits in 1ae3deebc3ac16e276b6558e01420f8e605def08..e2f0bdc4031866734661dcdb548184bde1450baf 2024-06-29 16:59:51 +0000 to 2024-07-15 17:52:44 +0000 - Suppress type length limit test and note that it is not enforced (rust-lang/reference#1527) - elaborate on slice wide pointer metadata (rust-lang/reference#1499) - '.inst' in inline-assembly changed to '.insn' (rust-lang/reference#1453) - Clarify that `asm!` blocks can be duplicated or deduplicated by the compiler (rust-lang/reference#1441) - Add mdbook-spec (rust-lang/reference#1520) - Add note about static libraries not linking their dependencies (rust-lang/reference#1472) - more explicitly explain the UB around immutable extern statics (rust-lang/reference#1502) - Improvements to `items/functions.md` (rust-lang/reference#1458) - Enable mdbook smart-punctuation. (rust-lang/reference#1516) ## rust-lang/rust-by-example 1 commits in 658c6c27cb975b92227936024816986c2d3716fb..89aecb6951b77bc746da73df8c9f2b2ceaad494a 2024-07-11 12:33:43 UTC to 2024-07-11 12:33:43 UTC - Update option_result.md (rust-lang/rust-by-example#1864) ## rust-lang/rustc-dev-guide 6 commits in d6e3a32a557db5902e714604def8015d6bb7e0f7..0c4d55cb59fe440d1a630e4e5774d043968edb3f 2024-07-15 15:16:43 UTC to 2024-07-01 19:05:14 UTC - Improve documentation of MIR queries & passes (rust-lang/rustc-dev-guide#1434) - Bump dependencies for date-check tool (rust-lang/rustc-dev-guide#2012) - Fix typo: lists -> lints (rust-lang/rustc-dev-guide#2011) - use "bootstrap" instead of "rustbuild" (rust-lang/rustc-dev-guide#2010) - Fix grammar issue in optimize-build.md (rust-lang/rustc-dev-guide#2009) - Update name of Fuchsia builder (rust-lang/rustc-dev-guide#2008)

Rollup merge of rust-lang#127770 - rustbot:docs-update, r=ehuss Update books ## rust-lang/book 3 commits in f1e49bf7a8ea6c31ce016a52b8a4f6e1ffcfbc64..67fa536768013d9d5a13f3a06790521d511ef711 2024-07-12 21:21:45 UTC to 2024-07-05 17:35:06 UTC - Use Rust 2021 Edition for mdBook (rust-lang/book#3974) - Backport changes to chapter 11 (rust-lang/book#3969) - Upgrade to Rust 1.79.0 (rust-lang/book#3968) ## rust-lang/edition-guide 2 commits in 941db8b3df45fd46cd87b50a5c86714b91dcde9c..5454de3d12b9ccc6375b629cf7ccda8264640aac 2024-07-14 07:06:34 UTC to 2024-07-12 06:05:29 UTC - Update timeline etc. for Rust 2024 - 2024: Add note about never_type_fallback_flowing_into_unsafe lint level. (rust-lang/edition-guide#311) ## rust-embedded/book 1 commits in b10c6acaf0f43481f6600e95d4b5013446e29f7a..019f3928d8b939ec71b63722dcc2e46330156441 2024-07-11 17:46:10 UTC to 2024-07-11 17:46:10 UTC - typo on tooling.md (rust-embedded/book#373) ## rust-lang/reference 9 commits in 1ae3deebc3ac16e276b6558e01420f8e605def08..e2f0bdc4031866734661dcdb548184bde1450baf 2024-06-29 16:59:51 +0000 to 2024-07-15 17:52:44 +0000 - Suppress type length limit test and note that it is not enforced (rust-lang/reference#1527) - elaborate on slice wide pointer metadata (rust-lang/reference#1499) - '.inst' in inline-assembly changed to '.insn' (rust-lang/reference#1453) - Clarify that `asm!` blocks can be duplicated or deduplicated by the compiler (rust-lang/reference#1441) - Add mdbook-spec (rust-lang/reference#1520) - Add note about static libraries not linking their dependencies (rust-lang/reference#1472) - more explicitly explain the UB around immutable extern statics (rust-lang/reference#1502) - Improvements to `items/functions.md` (rust-lang/reference#1458) - Enable mdbook smart-punctuation. (rust-lang/reference#1516) ## rust-lang/rust-by-example 1 commits in 658c6c27cb975b92227936024816986c2d3716fb..89aecb6951b77bc746da73df8c9f2b2ceaad494a 2024-07-11 12:33:43 UTC to 2024-07-11 12:33:43 UTC - Update option_result.md (rust-lang/rust-by-example#1864) ## rust-lang/rustc-dev-guide 6 commits in d6e3a32a557db5902e714604def8015d6bb7e0f7..0c4d55cb59fe440d1a630e4e5774d043968edb3f 2024-07-15 15:16:43 UTC to 2024-07-01 19:05:14 UTC - Improve documentation of MIR queries & passes (rust-lang/rustc-dev-guide#1434) - Bump dependencies for date-check tool (rust-lang/rustc-dev-guide#2012) - Fix typo: lists -> lints (rust-lang/rustc-dev-guide#2011) - use "bootstrap" instead of "rustbuild" (rust-lang/rustc-dev-guide#2010) - Fix grammar issue in optimize-build.md (rust-lang/rustc-dev-guide#2009) - Update name of Fuchsia builder (rust-lang/rustc-dev-guide#2008)

JohnTitor added waiting-on-review This PR is waiting for a reviewer to verify its content blocked This PR is blocked waiting for some other PR and removed waiting-on-review This PR is waiting for a reviewer to verify its content labels Aug 17, 2022

tshepang reviewed Aug 22, 2022

View reviewed changes

src/mir/passes.md Outdated Show resolved Hide resolved

JohnTitor added waiting-on-review This PR is waiting for a reviewer to verify its content and removed blocked This PR is blocked waiting for some other PR labels Sep 2, 2022

JohnTitor added blocked This PR is blocked waiting for some other PR and removed waiting-on-review This PR is waiting for a reviewer to verify its content labels Sep 12, 2022

jyn514 removed the blocked This PR is blocked waiting for some other PR label Jan 1, 2023

JohnTitor added the waiting-on-review This PR is waiting for a reviewer to verify its content label Feb 2, 2023

oli-obk requested changes Feb 9, 2023

View reviewed changes

src/mir/passes.md Outdated Show resolved Hide resolved

spastorino added waiting-on-author This PR is waiting for additional action by the OP and removed waiting-on-review This PR is waiting for a reviewer to verify its content labels Feb 15, 2023

Jaic1 requested review from oli-obk and tshepang June 30, 2024 03:10

oli-obk approved these changes Jul 9, 2024

View reviewed changes

Jaic1 and others added 3 commits July 10, 2024 13:51

Improve doc of MIR queries & passes

760af30

Typo in src/mir/passes.md

5d5eaba

accidently -> accidentally Co-authored-by: Tshepang Mbambo <tshepang@gmail.com>

refine mir passes doc

1f9d4e2

Jaic1 force-pushed the mir-queries branch from b5b2057 to 1f9d4e2 Compare July 10, 2024 05:51

spastorino approved these changes Jul 10, 2024

View reviewed changes

oli-obk merged commit 0c4d55c into rust-lang:master Jul 15, 2024
1 check passed

rustbot mentioned this pull request Jul 15, 2024

Update books rust-lang/rust#127770

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve documentation of MIR queries & passes #1434

Improve documentation of MIR queries & passes #1434

Jaic1 commented Aug 16, 2022 •

edited

Loading

tshepang commented Aug 31, 2022

Jaic1 commented Sep 5, 2022

jyn514 commented Jan 1, 2023

JohnTitor commented Feb 9, 2023

oli-obk commented Feb 9, 2023

spastorino commented Oct 26, 2023

Jaic1 commented Jun 30, 2024

Jaic1 commented Jun 30, 2024

oli-obk commented Jul 9, 2024

Jaic1 commented Jul 10, 2024

spastorino left a comment

Improve documentation of MIR queries & passes #1434

Improve documentation of MIR queries & passes #1434

Conversation

Jaic1 commented Aug 16, 2022 • edited Loading

tshepang commented Aug 31, 2022

Jaic1 commented Sep 5, 2022

jyn514 commented Jan 1, 2023

JohnTitor commented Feb 9, 2023

oli-obk commented Feb 9, 2023

spastorino commented Oct 26, 2023

Jaic1 commented Jun 30, 2024

Jaic1 commented Jun 30, 2024

oli-obk commented Jul 9, 2024

Jaic1 commented Jul 10, 2024

spastorino left a comment

Choose a reason for hiding this comment

Jaic1 commented Aug 16, 2022 •

edited

Loading