rust-lang / rust-lang/rustc-dev-guide

document MIR-optimizations

Open
#331 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-mir-opt C-enhancement E-hard E-help-wanted T-compiler WG-mir-opt
Dominant language
HTML
Stars
1.9k
Forks
613
Avg merge
17h 24m
Merged PRs (30d)
39

Description

Original discussion is in Zulip.

At now, src/mir/optimizations.md is empty so we should document MIR-optimizations.

oli-obk pointed out these:

  • guaranteed and required ones
  • some that don't optimize, but just check stuff
  • some that are only turned on in release mode

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading src/mir/optimizations.md and consult the original discussion in Zulip. Identify the guaranteed and required optimizations, checks that do not optimize, and optimizations enabled only in release mode. Done means the empty guide explains these MIR optimization categories accurately.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.