about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorNiko Matsakis <niko@alum.mit.edu>2018-01-16 17:35:19 -0500
committerNiko Matsakis <niko@alum.mit.edu>2018-01-16 17:35:19 -0500
commite049167364462e3de46d87c50e2b145add4412c2 (patch)
tree11d4ab91a4ec1e99fda072adfc2ee111fc8274e5 /src/doc/rustc-dev-guide
parentdfee0655aa93bbe7abdc2806f43bd67b6241c236 (diff)
downloadrust-e049167364462e3de46d87c50e2b145add4412c2.tar.gz
rust-e049167364462e3de46d87c50e2b145add4412c2.zip
add outline and chapters
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/.gitignore2
-rw-r--r--src/doc/rustc-dev-guide/book.toml5
-rw-r--r--src/doc/rustc-dev-guide/src/SUMMARY.md3
-rw-r--r--src/doc/rustc-dev-guide/src/chapter_1.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/SUMMARY.md19
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-010-how-to-build-and-run.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-020-running-tests.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-030-walkthrough.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-040-compiler-conventions.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-050-the-parser.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-060-macro-expansion.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-070-name-resolution.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-080-hir-lowering.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-090-ty.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-100-type-inference.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-110-trait-resolution.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-120-type-checking.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-130-mir-construction.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-140-mir-borrowck.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-150-mir-optimizations.md1
-rw-r--r--src/doc/rustc-dev-guide/src/src/chap-160-trans.md1
21 files changed, 41 insertions, 5 deletions
diff --git a/src/doc/rustc-dev-guide/.gitignore b/src/doc/rustc-dev-guide/.gitignore
index 5a0bf0317d7..7585238efed 100644
--- a/src/doc/rustc-dev-guide/.gitignore
+++ b/src/doc/rustc-dev-guide/.gitignore
@@ -1 +1 @@
-/book
+book
diff --git a/src/doc/rustc-dev-guide/book.toml b/src/doc/rustc-dev-guide/book.toml
new file mode 100644
index 00000000000..485a12ca3bb
--- /dev/null
+++ b/src/doc/rustc-dev-guide/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/doc/rustc-dev-guide/src/SUMMARY.md b/src/doc/rustc-dev-guide/src/SUMMARY.md
deleted file mode 100644
index 7390c82896e..00000000000
--- a/src/doc/rustc-dev-guide/src/SUMMARY.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# Summary
-
-- [Chapter 1](./chapter_1.md)
diff --git a/src/doc/rustc-dev-guide/src/chapter_1.md b/src/doc/rustc-dev-guide/src/chapter_1.md
deleted file mode 100644
index b743fda3546..00000000000
--- a/src/doc/rustc-dev-guide/src/chapter_1.md
+++ /dev/null
@@ -1 +0,0 @@
-# Chapter 1
diff --git a/src/doc/rustc-dev-guide/src/src/SUMMARY.md b/src/doc/rustc-dev-guide/src/src/SUMMARY.md
new file mode 100644
index 00000000000..134014963cb
--- /dev/null
+++ b/src/doc/rustc-dev-guide/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/doc/rustc-dev-guide/src/src/chap-010-how-to-build-and-run.md b/src/doc/rustc-dev-guide/src/src/chap-010-how-to-build-and-run.md
new file mode 100644
index 00000000000..505836094d1
--- /dev/null
+++ b/src/doc/rustc-dev-guide/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/doc/rustc-dev-guide/src/src/chap-020-running-tests.md b/src/doc/rustc-dev-guide/src/src/chap-020-running-tests.md
new file mode 100644
index 00000000000..02c9de84067
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-020-running-tests.md
@@ -0,0 +1 @@
+# Using the compiler testing framework
diff --git a/src/doc/rustc-dev-guide/src/src/chap-030-walkthrough.md b/src/doc/rustc-dev-guide/src/src/chap-030-walkthrough.md
new file mode 100644
index 00000000000..ab158177a42
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-030-walkthrough.md
@@ -0,0 +1 @@
+# Walkthrough: a typical contribution
diff --git a/src/doc/rustc-dev-guide/src/src/chap-040-compiler-conventions.md b/src/doc/rustc-dev-guide/src/src/chap-040-compiler-conventions.md
new file mode 100644
index 00000000000..314221fa0e5
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-040-compiler-conventions.md
@@ -0,0 +1 @@
+# Conventions used in the compiler
diff --git a/src/doc/rustc-dev-guide/src/src/chap-050-the-parser.md b/src/doc/rustc-dev-guide/src/src/chap-050-the-parser.md
new file mode 100644
index 00000000000..ab756895ae6
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-050-the-parser.md
@@ -0,0 +1 @@
+# The parser
diff --git a/src/doc/rustc-dev-guide/src/src/chap-060-macro-expansion.md b/src/doc/rustc-dev-guide/src/src/chap-060-macro-expansion.md
new file mode 100644
index 00000000000..12b95cb6cb0
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-060-macro-expansion.md
@@ -0,0 +1 @@
+# Macro expansion
diff --git a/src/doc/rustc-dev-guide/src/src/chap-070-name-resolution.md b/src/doc/rustc-dev-guide/src/src/chap-070-name-resolution.md
new file mode 100644
index 00000000000..487a31d2c52
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-070-name-resolution.md
@@ -0,0 +1 @@
+# Name resolution
diff --git a/src/doc/rustc-dev-guide/src/src/chap-080-hir-lowering.md b/src/doc/rustc-dev-guide/src/src/chap-080-hir-lowering.md
new file mode 100644
index 00000000000..b2b6a7cdf8f
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-080-hir-lowering.md
@@ -0,0 +1 @@
+# HIR lowering
diff --git a/src/doc/rustc-dev-guide/src/src/chap-090-ty.md b/src/doc/rustc-dev-guide/src/src/chap-090-ty.md
new file mode 100644
index 00000000000..1762ce037fa
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-090-ty.md
@@ -0,0 +1 @@
+# Representing types (`ty` module in depth)
diff --git a/src/doc/rustc-dev-guide/src/src/chap-100-type-inference.md b/src/doc/rustc-dev-guide/src/src/chap-100-type-inference.md
new file mode 100644
index 00000000000..0fc99252ab7
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-100-type-inference.md
@@ -0,0 +1 @@
+# Type inference
diff --git a/src/doc/rustc-dev-guide/src/src/chap-110-trait-resolution.md b/src/doc/rustc-dev-guide/src/src/chap-110-trait-resolution.md
new file mode 100644
index 00000000000..dd16aac62b4
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-110-trait-resolution.md
@@ -0,0 +1 @@
+# Trait resolution
diff --git a/src/doc/rustc-dev-guide/src/src/chap-120-type-checking.md b/src/doc/rustc-dev-guide/src/src/chap-120-type-checking.md
new file mode 100644
index 00000000000..c559c128360
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-120-type-checking.md
@@ -0,0 +1 @@
+# Type checking
diff --git a/src/doc/rustc-dev-guide/src/src/chap-130-mir-construction.md b/src/doc/rustc-dev-guide/src/src/chap-130-mir-construction.md
new file mode 100644
index 00000000000..898fcd529ed
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-130-mir-construction.md
@@ -0,0 +1 @@
+# MIR construction
diff --git a/src/doc/rustc-dev-guide/src/src/chap-140-mir-borrowck.md b/src/doc/rustc-dev-guide/src/src/chap-140-mir-borrowck.md
new file mode 100644
index 00000000000..55bc9fc982a
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-140-mir-borrowck.md
@@ -0,0 +1 @@
+# MIR borrowck
diff --git a/src/doc/rustc-dev-guide/src/src/chap-150-mir-optimizations.md b/src/doc/rustc-dev-guide/src/src/chap-150-mir-optimizations.md
new file mode 100644
index 00000000000..ddafa0c99c3
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-150-mir-optimizations.md
@@ -0,0 +1 @@
+# MIR optimizations
diff --git a/src/doc/rustc-dev-guide/src/src/chap-160-trans.md b/src/doc/rustc-dev-guide/src/src/chap-160-trans.md
new file mode 100644
index 00000000000..7092b7a0baf
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/src/chap-160-trans.md
@@ -0,0 +1 @@
+# trans: generating LLVM IR