Skip to content

Commit eaa28eb

Browse files
committed
add outline and chapters
1 parent 35b1429 commit eaa28eb

21 files changed

+41
-5
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
/book
1+
book

book.toml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[book]
2+
title = "Guide to Rustc Development"
3+
author = "Rustc developers"
4+
description = "A guide to developing rustc "
5+

src/SUMMARY.md

-3
This file was deleted.

src/chapter_1.md

-1
This file was deleted.

src/src/SUMMARY.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Summary
2+
3+
- [How to build the compiler and run what you built](./chap-010-how-to-build-and-run.md)
4+
- [Using the compiler testing framework](./chap-020-running-tests.md)
5+
- [Walkthrough: a typical contribution](./chap-030-walkthrough.md)
6+
- [Conventions used in the compiler](./chap-040-compiler-conventions.md)
7+
- [The parser](./chap-050-the-parser.md)
8+
- [Macro expansion](./chap-060-macro-expansion.md)
9+
- [Name resolution](./chap-070-name-resolution.md)
10+
- [HIR lowering](./chap-080-hir-lowering.md)
11+
- [Representing types (`ty` module in depth)](./chap-090-ty.md)
12+
- [Type inference](./chap-100-type-inference.md)
13+
- [Trait resolution](./chap-110-trait-resolution.md)
14+
- [Type checking](./chap-120-type-checking.md)
15+
- [MIR construction](./chap-130-mir-construction.md)
16+
- [MIR borrowck](./chap-140-mir-borrowck.md)
17+
- [MIR optimizations](./chap-150-mir-optimizations.md)
18+
- [trans: generating LLVM IR](./chap-160-trans.md)
19+
+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# How to build the compiler and run what you built

src/src/chap-020-running-tests.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Using the compiler testing framework

src/src/chap-030-walkthrough.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Walkthrough: a typical contribution
+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Conventions used in the compiler

src/src/chap-050-the-parser.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# The parser

src/src/chap-060-macro-expansion.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Macro expansion

src/src/chap-070-name-resolution.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Name resolution

src/src/chap-080-hir-lowering.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# HIR lowering

src/src/chap-090-ty.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Representing types (`ty` module in depth)

src/src/chap-100-type-inference.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Type inference

src/src/chap-110-trait-resolution.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Trait resolution

src/src/chap-120-type-checking.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Type checking

src/src/chap-130-mir-construction.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# MIR construction

src/src/chap-140-mir-borrowck.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# MIR borrowck

src/src/chap-150-mir-optimizations.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# MIR optimizations

src/src/chap-160-trans.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# trans: generating LLVM IR

0 commit comments

Comments
 (0)