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

Overview Chapter Followup

Open
#674 10 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

This issue exists to track things we want to improve on. Please add things here:

  • Replace bullets with prose.
  • Perhaps move some of the content about command line parsing, lexing, and parsing to the appropriate chapters.
  • More info on type checking and type inference.
  • Fix some of the TODOs
  • add more links to other parts of the guide
  • add diagrams
  • answer unresolved questions at the bottom
  • figure out where the following happen and add them back to the list of steps
    • type checking
    • trait solving
    • const eval
    • size optimizations
  • Perhaps use more content from https://rust-lang.zulipchat.com/#narrow/stream/182449-t-compiler.2Fhelp/topic/history.20of.20typeck.20and.20borrowck about HAIR
  • find out if there are other reasons to use query system beyond incremental
  • improve descriptions of bootstrapping.
  • verify info about parallel rustc effort

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 with the rustc-dev-guide Overview chapter and review each open checklist item, including the sections on command-line parsing, lexing, parsing, type checking, trait solving, const evaluation, and size optimizations. Done means resolving specific TODOs and unanswered questions, adding links or diagrams where needed, verifying the parallel-rustc information, and updating the checklist.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.