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 the compiler and run what you built
  • 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

---

• Part 2: How rustc works
• High-level overview of the compiler source
• The Rustc Driver
  • 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
• 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
• The borrow checker
  • Tracking moves and initialization
    • Move paths
  • MIR type checker
  • Region inference
• Constant evaluation
  • miri const evaluator
• Parameter Environments
• Code Generation
  • Updating LLVM
• Emitting Diagnostics

---

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