rustc-dev-guide/src/SUMMARY.md

Summary

About this guide

---

• Part 1: Building, debugging, and contributing to Rustc
  • About the compiler team
  • How to Build and Run the Compiler
    • Build and Install distribution artifacts
    • Documenting Compiler
  • The compiler testing framework
    • Running tests
    • Adding new tests
    • Using compiletest + commands to control test execution
  • Walkthrough: a typical contribution
  • Implementing new features
  • Stabilizing Features
  • Debugging the Compiler
  • Profiling the compiler
    • with the linux perf tool
  • Coding conventions
  • crates.io Dependencies
  • Emitting Errors and other Diagnostics
    • JSON diagnostic format
• Part 2: How rustc works
  • High-level overview of the compiler source
  • The Rustc Driver and Interface
    • Rustdoc
  • Queries: demand-driven compilation
    • The Query Evaluation Model in Detail
    • Incremental compilation
    • Incremental compilation In Detail
    • Debugging and Testing
  • The parser
  • #[test] Implementation
  • Macro expansion
  • Name resolution
  • The HIR (High-level IR)
    • Lowering AST to HIR
    • Debugging
  • Closure expansion
  • The ty module: representing types
  • Kinds
  • Type inference
  • Trait solving (old-style)
    • Higher-ranked trait bounds
    • Caching subtleties
    • Specialization
  • Trait solving (new-style)
    • Lowering to logic
      • Goals and clauses
      • Equality and associated types
      • Implied bounds
      • Region constraints
      • The lowering module in rustc
      • Lowering rules
      • Well-formedness checking
    • Canonical queries
      • Canonicalization
    • The SLG solver
    • An Overview of Chalk
    • Bibliography
  • Type checking
    • Method Lookup
    • Variance
    • Existential Types
  • The MIR (Mid-level IR)
    • MIR construction
    • MIR visitor and traversal
    • MIR passes: getting the MIR for a function
    • MIR optimizations
    • Debugging
  • The borrow checker
    • Tracking moves and initialization
      • Move paths
    • MIR type checker
    • Region inference
      • Constraint propagation
      • Lifetime parameters
      • Member constraints
      • Placeholders and universes
      • Closure constraints
      • Errror reporting
    • Two-phase-borrows
  • Constant evaluation
    • miri const evaluator
  • Parameter Environments
  • Code Generation
    • Updating LLVM
    • Debugging LLVM
  • Profile-guided Optimization
  • Debugging Support in Rust Compiler

---

Appendix A: Stupid Stats Appendix B: Background material Appendix C: Glossary Appendix D: Code Index Appendix E: Bibliography