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-17 09:30:13 -0500
committerGitHub <noreply@github.com>2018-01-17 09:30:13 -0500
commit787a30042b438827636d67f63beef76917b82f6f (patch)
tree30cff3d0016556c0aa0c231a6784010de95381ab /src/doc/rustc-dev-guide
parentab618a38ee2b679b5af1c6bff8f04a6f61977bfd (diff)
parentfb0e1b38c8d2073b85a7bd4409d4f88c8ec2225c (diff)
Merge pull request #7 from nikomatsakis/master
basic setup, part 1
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/README.md28
-rw-r--r--src/doc/rustc-dev-guide/src/SUMMARY.md (renamed from src/doc/rustc-dev-guide/src/src/SUMMARY.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-010-how-to-build-and-run.md (renamed from src/doc/rustc-dev-guide/src/src/chap-010-how-to-build-and-run.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-020-running-tests.md (renamed from src/doc/rustc-dev-guide/src/src/chap-020-running-tests.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-030-walkthrough.md (renamed from src/doc/rustc-dev-guide/src/src/chap-030-walkthrough.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-040-compiler-conventions.md (renamed from src/doc/rustc-dev-guide/src/src/chap-040-compiler-conventions.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-050-the-parser.md (renamed from src/doc/rustc-dev-guide/src/src/chap-050-the-parser.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-060-macro-expansion.md (renamed from src/doc/rustc-dev-guide/src/src/chap-060-macro-expansion.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-070-name-resolution.md (renamed from src/doc/rustc-dev-guide/src/src/chap-070-name-resolution.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-080-hir-lowering.md (renamed from src/doc/rustc-dev-guide/src/src/chap-080-hir-lowering.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-090-ty.md (renamed from src/doc/rustc-dev-guide/src/src/chap-090-ty.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-100-type-inference.md (renamed from src/doc/rustc-dev-guide/src/src/chap-100-type-inference.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-110-trait-resolution.md (renamed from src/doc/rustc-dev-guide/src/src/chap-110-trait-resolution.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-120-type-checking.md (renamed from src/doc/rustc-dev-guide/src/src/chap-120-type-checking.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-130-mir-construction.md (renamed from src/doc/rustc-dev-guide/src/src/chap-130-mir-construction.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-140-mir-borrowck.md (renamed from src/doc/rustc-dev-guide/src/src/chap-140-mir-borrowck.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-150-mir-optimizations.md (renamed from src/doc/rustc-dev-guide/src/src/chap-150-mir-optimizations.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/chap-160-trans.md (renamed from src/doc/rustc-dev-guide/src/src/chap-160-trans.md)0
-rw-r--r--src/doc/rustc-dev-guide/src/glossary.md (renamed from src/doc/rustc-dev-guide/src/src/glossary.md)0
19 files changed, 25 insertions, 3 deletions
diff --git a/src/doc/rustc-dev-guide/README.md b/src/doc/rustc-dev-guide/README.md
index b8929c1e3f9..beb2507cd21 100644
--- a/src/doc/rustc-dev-guide/README.md
+++ b/src/doc/rustc-dev-guide/README.md
@@ -1,3 +1,25 @@
-An attempt to document how the compiler works. The intention is to
-bootstrap this "in repo" and eventually move the text over into the
-main rustc repo.
+This is a collaborate effort to build a guide that explains how rustc
+works. The aim of the guide is to help new contributors get oriented
+to rustc, as well as to help more experienced folks in figuring out
+some new part of the compiler that they haven't worked on before.
+
+The guide can be useful today, but it has a lot of work still go.
+Once it gets more complete, the plan is probably to move it into the
+[main Rust repository](https://github.com/rust-lang/rust/).
+
+### Contributing to the guide
+
+If you'd like to help finish the guide, we'd love to have you! The
+main tracking issue for the guide
+[can be found here](https://github.com/rust-lang-nursery/rustc-guide/issues/6). From
+there, you can find a list of all the planned chapters and subsections
+-- if you think something is missing, please open an issue about it!
+Otherwise, find a chapter that sounds interesting to you and then go
+to its associated issue. There should be a list of things to do.
+
+**In general, if you don't know how the compiler works, that is not a
+problem!** In that case, what we will do is to schedule a bit of time
+for you to talk with someone who **does** know the code, or who wants
+to pair with you and figure it out.  Then you can work on writing up
+what you learned.
+
diff --git a/src/doc/rustc-dev-guide/src/src/SUMMARY.md b/src/doc/rustc-dev-guide/src/SUMMARY.md
index 21c87188555..21c87188555 100644
--- a/src/doc/rustc-dev-guide/src/src/SUMMARY.md
+++ b/src/doc/rustc-dev-guide/src/SUMMARY.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/chap-010-how-to-build-and-run.md
index 505836094d1..505836094d1 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-010-how-to-build-and-run.md
+++ b/src/doc/rustc-dev-guide/src/chap-010-how-to-build-and-run.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-020-running-tests.md b/src/doc/rustc-dev-guide/src/chap-020-running-tests.md
index 02c9de84067..02c9de84067 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-020-running-tests.md
+++ b/src/doc/rustc-dev-guide/src/chap-020-running-tests.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-030-walkthrough.md b/src/doc/rustc-dev-guide/src/chap-030-walkthrough.md
index ab158177a42..ab158177a42 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-030-walkthrough.md
+++ b/src/doc/rustc-dev-guide/src/chap-030-walkthrough.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-040-compiler-conventions.md b/src/doc/rustc-dev-guide/src/chap-040-compiler-conventions.md
index 314221fa0e5..314221fa0e5 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-040-compiler-conventions.md
+++ b/src/doc/rustc-dev-guide/src/chap-040-compiler-conventions.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-050-the-parser.md b/src/doc/rustc-dev-guide/src/chap-050-the-parser.md
index ab756895ae6..ab756895ae6 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-050-the-parser.md
+++ b/src/doc/rustc-dev-guide/src/chap-050-the-parser.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-060-macro-expansion.md b/src/doc/rustc-dev-guide/src/chap-060-macro-expansion.md
index 12b95cb6cb0..12b95cb6cb0 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-060-macro-expansion.md
+++ b/src/doc/rustc-dev-guide/src/chap-060-macro-expansion.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-070-name-resolution.md b/src/doc/rustc-dev-guide/src/chap-070-name-resolution.md
index 487a31d2c52..487a31d2c52 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-070-name-resolution.md
+++ b/src/doc/rustc-dev-guide/src/chap-070-name-resolution.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-080-hir-lowering.md b/src/doc/rustc-dev-guide/src/chap-080-hir-lowering.md
index b2b6a7cdf8f..b2b6a7cdf8f 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-080-hir-lowering.md
+++ b/src/doc/rustc-dev-guide/src/chap-080-hir-lowering.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-090-ty.md b/src/doc/rustc-dev-guide/src/chap-090-ty.md
index 1762ce037fa..1762ce037fa 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-090-ty.md
+++ b/src/doc/rustc-dev-guide/src/chap-090-ty.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-100-type-inference.md b/src/doc/rustc-dev-guide/src/chap-100-type-inference.md
index 0fc99252ab7..0fc99252ab7 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-100-type-inference.md
+++ b/src/doc/rustc-dev-guide/src/chap-100-type-inference.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-110-trait-resolution.md b/src/doc/rustc-dev-guide/src/chap-110-trait-resolution.md
index dd16aac62b4..dd16aac62b4 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-110-trait-resolution.md
+++ b/src/doc/rustc-dev-guide/src/chap-110-trait-resolution.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-120-type-checking.md b/src/doc/rustc-dev-guide/src/chap-120-type-checking.md
index c559c128360..c559c128360 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-120-type-checking.md
+++ b/src/doc/rustc-dev-guide/src/chap-120-type-checking.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-130-mir-construction.md b/src/doc/rustc-dev-guide/src/chap-130-mir-construction.md
index 898fcd529ed..898fcd529ed 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-130-mir-construction.md
+++ b/src/doc/rustc-dev-guide/src/chap-130-mir-construction.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-140-mir-borrowck.md b/src/doc/rustc-dev-guide/src/chap-140-mir-borrowck.md
index 55bc9fc982a..55bc9fc982a 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-140-mir-borrowck.md
+++ b/src/doc/rustc-dev-guide/src/chap-140-mir-borrowck.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-150-mir-optimizations.md b/src/doc/rustc-dev-guide/src/chap-150-mir-optimizations.md
index ddafa0c99c3..ddafa0c99c3 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-150-mir-optimizations.md
+++ b/src/doc/rustc-dev-guide/src/chap-150-mir-optimizations.md
diff --git a/src/doc/rustc-dev-guide/src/src/chap-160-trans.md b/src/doc/rustc-dev-guide/src/chap-160-trans.md
index 7092b7a0baf..7092b7a0baf 100644
--- a/src/doc/rustc-dev-guide/src/src/chap-160-trans.md
+++ b/src/doc/rustc-dev-guide/src/chap-160-trans.md
diff --git a/src/doc/rustc-dev-guide/src/src/glossary.md b/src/doc/rustc-dev-guide/src/glossary.md
index b66e17ea3c1..b66e17ea3c1 100644
--- a/src/doc/rustc-dev-guide/src/src/glossary.md
+++ b/src/doc/rustc-dev-guide/src/glossary.md