From eaa28eb8536b483b88e8a1c404b4715e04edf97f Mon Sep 17 00:00:00 2001 From: Niko Matsakis Date: Tue, 16 Jan 2018 17:35:19 -0500 Subject: [PATCH] add outline and chapters --- .gitignore | 2 +- book.toml | 5 +++++ src/SUMMARY.md | 3 --- src/chapter_1.md | 1 - src/src/SUMMARY.md | 19 +++++++++++++++++++ src/src/chap-010-how-to-build-and-run.md | 1 + src/src/chap-020-running-tests.md | 1 + src/src/chap-030-walkthrough.md | 1 + src/src/chap-040-compiler-conventions.md | 1 + src/src/chap-050-the-parser.md | 1 + src/src/chap-060-macro-expansion.md | 1 + src/src/chap-070-name-resolution.md | 1 + src/src/chap-080-hir-lowering.md | 1 + src/src/chap-090-ty.md | 1 + src/src/chap-100-type-inference.md | 1 + src/src/chap-110-trait-resolution.md | 1 + src/src/chap-120-type-checking.md | 1 + src/src/chap-130-mir-construction.md | 1 + src/src/chap-140-mir-borrowck.md | 1 + src/src/chap-150-mir-optimizations.md | 1 + src/src/chap-160-trans.md | 1 + 21 files changed, 41 insertions(+), 5 deletions(-) create mode 100644 book.toml delete mode 100644 src/SUMMARY.md delete mode 100644 src/chapter_1.md create mode 100644 src/src/SUMMARY.md create mode 100644 src/src/chap-010-how-to-build-and-run.md create mode 100644 src/src/chap-020-running-tests.md create mode 100644 src/src/chap-030-walkthrough.md create mode 100644 src/src/chap-040-compiler-conventions.md create mode 100644 src/src/chap-050-the-parser.md create mode 100644 src/src/chap-060-macro-expansion.md create mode 100644 src/src/chap-070-name-resolution.md create mode 100644 src/src/chap-080-hir-lowering.md create mode 100644 src/src/chap-090-ty.md create mode 100644 src/src/chap-100-type-inference.md create mode 100644 src/src/chap-110-trait-resolution.md create mode 100644 src/src/chap-120-type-checking.md create mode 100644 src/src/chap-130-mir-construction.md create mode 100644 src/src/chap-140-mir-borrowck.md create mode 100644 src/src/chap-150-mir-optimizations.md create mode 100644 src/src/chap-160-trans.md diff --git a/.gitignore b/.gitignore index 5a0bf031..7585238e 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1 @@ -/book +book diff --git a/book.toml b/book.toml new file mode 100644 index 00000000..485a12ca --- /dev/null +++ b/book.toml @@ -0,0 +1,5 @@ +[book] +title = "Guide to Rustc Development" +author = "Rustc developers" +description = "A guide to developing rustc " + diff --git a/src/SUMMARY.md b/src/SUMMARY.md deleted file mode 100644 index 7390c828..00000000 --- a/src/SUMMARY.md +++ /dev/null @@ -1,3 +0,0 @@ -# Summary - -- [Chapter 1](./chapter_1.md) diff --git a/src/chapter_1.md b/src/chapter_1.md deleted file mode 100644 index b743fda3..00000000 --- a/src/chapter_1.md +++ /dev/null @@ -1 +0,0 @@ -# Chapter 1 diff --git a/src/src/SUMMARY.md b/src/src/SUMMARY.md new file mode 100644 index 00000000..13401496 --- /dev/null +++ b/src/src/SUMMARY.md @@ -0,0 +1,19 @@ +# Summary + +- [How to build the compiler and run what you built](./chap-010-how-to-build-and-run.md) +- [Using the compiler testing framework](./chap-020-running-tests.md) +- [Walkthrough: a typical contribution](./chap-030-walkthrough.md) +- [Conventions used in the compiler](./chap-040-compiler-conventions.md) +- [The parser](./chap-050-the-parser.md) +- [Macro expansion](./chap-060-macro-expansion.md) +- [Name resolution](./chap-070-name-resolution.md) +- [HIR lowering](./chap-080-hir-lowering.md) +- [Representing types (`ty` module in depth)](./chap-090-ty.md) +- [Type inference](./chap-100-type-inference.md) +- [Trait resolution](./chap-110-trait-resolution.md) +- [Type checking](./chap-120-type-checking.md) +- [MIR construction](./chap-130-mir-construction.md) +- [MIR borrowck](./chap-140-mir-borrowck.md) +- [MIR optimizations](./chap-150-mir-optimizations.md) +- [trans: generating LLVM IR](./chap-160-trans.md) + diff --git a/src/src/chap-010-how-to-build-and-run.md b/src/src/chap-010-how-to-build-and-run.md new file mode 100644 index 00000000..50583609 --- /dev/null +++ b/src/src/chap-010-how-to-build-and-run.md @@ -0,0 +1 @@ +# How to build the compiler and run what you built diff --git a/src/src/chap-020-running-tests.md b/src/src/chap-020-running-tests.md new file mode 100644 index 00000000..02c9de84 --- /dev/null +++ b/src/src/chap-020-running-tests.md @@ -0,0 +1 @@ +# Using the compiler testing framework diff --git a/src/src/chap-030-walkthrough.md b/src/src/chap-030-walkthrough.md new file mode 100644 index 00000000..ab158177 --- /dev/null +++ b/src/src/chap-030-walkthrough.md @@ -0,0 +1 @@ +# Walkthrough: a typical contribution diff --git a/src/src/chap-040-compiler-conventions.md b/src/src/chap-040-compiler-conventions.md new file mode 100644 index 00000000..314221fa --- /dev/null +++ b/src/src/chap-040-compiler-conventions.md @@ -0,0 +1 @@ +# Conventions used in the compiler diff --git a/src/src/chap-050-the-parser.md b/src/src/chap-050-the-parser.md new file mode 100644 index 00000000..ab756895 --- /dev/null +++ b/src/src/chap-050-the-parser.md @@ -0,0 +1 @@ +# The parser diff --git a/src/src/chap-060-macro-expansion.md b/src/src/chap-060-macro-expansion.md new file mode 100644 index 00000000..12b95cb6 --- /dev/null +++ b/src/src/chap-060-macro-expansion.md @@ -0,0 +1 @@ +# Macro expansion diff --git a/src/src/chap-070-name-resolution.md b/src/src/chap-070-name-resolution.md new file mode 100644 index 00000000..487a31d2 --- /dev/null +++ b/src/src/chap-070-name-resolution.md @@ -0,0 +1 @@ +# Name resolution diff --git a/src/src/chap-080-hir-lowering.md b/src/src/chap-080-hir-lowering.md new file mode 100644 index 00000000..b2b6a7cd --- /dev/null +++ b/src/src/chap-080-hir-lowering.md @@ -0,0 +1 @@ +# HIR lowering diff --git a/src/src/chap-090-ty.md b/src/src/chap-090-ty.md new file mode 100644 index 00000000..1762ce03 --- /dev/null +++ b/src/src/chap-090-ty.md @@ -0,0 +1 @@ +# Representing types (`ty` module in depth) diff --git a/src/src/chap-100-type-inference.md b/src/src/chap-100-type-inference.md new file mode 100644 index 00000000..0fc99252 --- /dev/null +++ b/src/src/chap-100-type-inference.md @@ -0,0 +1 @@ +# Type inference diff --git a/src/src/chap-110-trait-resolution.md b/src/src/chap-110-trait-resolution.md new file mode 100644 index 00000000..dd16aac6 --- /dev/null +++ b/src/src/chap-110-trait-resolution.md @@ -0,0 +1 @@ +# Trait resolution diff --git a/src/src/chap-120-type-checking.md b/src/src/chap-120-type-checking.md new file mode 100644 index 00000000..c559c128 --- /dev/null +++ b/src/src/chap-120-type-checking.md @@ -0,0 +1 @@ +# Type checking diff --git a/src/src/chap-130-mir-construction.md b/src/src/chap-130-mir-construction.md new file mode 100644 index 00000000..898fcd52 --- /dev/null +++ b/src/src/chap-130-mir-construction.md @@ -0,0 +1 @@ +# MIR construction diff --git a/src/src/chap-140-mir-borrowck.md b/src/src/chap-140-mir-borrowck.md new file mode 100644 index 00000000..55bc9fc9 --- /dev/null +++ b/src/src/chap-140-mir-borrowck.md @@ -0,0 +1 @@ +# MIR borrowck diff --git a/src/src/chap-150-mir-optimizations.md b/src/src/chap-150-mir-optimizations.md new file mode 100644 index 00000000..ddafa0c9 --- /dev/null +++ b/src/src/chap-150-mir-optimizations.md @@ -0,0 +1 @@ +# MIR optimizations diff --git a/src/src/chap-160-trans.md b/src/src/chap-160-trans.md new file mode 100644 index 00000000..7092b7a0 --- /dev/null +++ b/src/src/chap-160-trans.md @@ -0,0 +1 @@ +# trans: generating LLVM IR