From 74ddbc04c0dbde89614c013d2acafa7f15dcbde5 Mon Sep 17 00:00:00 2001 From: Niko Matsakis Date: Wed, 17 Jan 2018 09:19:24 -0500 Subject: [PATCH 1/2] improve the README --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b8929c1e..beb2507c 100644 --- a/README.md +++ b/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. + From f0db733d99da7a8e49012e0ac6b7b1ca2da01cdf Mon Sep 17 00:00:00 2001 From: Niko Matsakis Date: Wed, 17 Jan 2018 09:25:59 -0500 Subject: [PATCH 2/2] remove `src/src` directory that somehow got created --- src/{src => }/SUMMARY.md | 0 src/{src => }/chap-010-how-to-build-and-run.md | 0 src/{src => }/chap-020-running-tests.md | 0 src/{src => }/chap-030-walkthrough.md | 0 src/{src => }/chap-040-compiler-conventions.md | 0 src/{src => }/chap-050-the-parser.md | 0 src/{src => }/chap-060-macro-expansion.md | 0 src/{src => }/chap-070-name-resolution.md | 0 src/{src => }/chap-080-hir-lowering.md | 0 src/{src => }/chap-090-ty.md | 0 src/{src => }/chap-100-type-inference.md | 0 src/{src => }/chap-110-trait-resolution.md | 0 src/{src => }/chap-120-type-checking.md | 0 src/{src => }/chap-130-mir-construction.md | 0 src/{src => }/chap-140-mir-borrowck.md | 0 src/{src => }/chap-150-mir-optimizations.md | 0 src/{src => }/chap-160-trans.md | 0 src/{src => }/glossary.md | 0 18 files changed, 0 insertions(+), 0 deletions(-) rename src/{src => }/SUMMARY.md (100%) rename src/{src => }/chap-010-how-to-build-and-run.md (100%) rename src/{src => }/chap-020-running-tests.md (100%) rename src/{src => }/chap-030-walkthrough.md (100%) rename src/{src => }/chap-040-compiler-conventions.md (100%) rename src/{src => }/chap-050-the-parser.md (100%) rename src/{src => }/chap-060-macro-expansion.md (100%) rename src/{src => }/chap-070-name-resolution.md (100%) rename src/{src => }/chap-080-hir-lowering.md (100%) rename src/{src => }/chap-090-ty.md (100%) rename src/{src => }/chap-100-type-inference.md (100%) rename src/{src => }/chap-110-trait-resolution.md (100%) rename src/{src => }/chap-120-type-checking.md (100%) rename src/{src => }/chap-130-mir-construction.md (100%) rename src/{src => }/chap-140-mir-borrowck.md (100%) rename src/{src => }/chap-150-mir-optimizations.md (100%) rename src/{src => }/chap-160-trans.md (100%) rename src/{src => }/glossary.md (100%) diff --git a/src/src/SUMMARY.md b/src/SUMMARY.md similarity index 100% rename from src/src/SUMMARY.md rename to src/SUMMARY.md diff --git a/src/src/chap-010-how-to-build-and-run.md b/src/chap-010-how-to-build-and-run.md similarity index 100% rename from src/src/chap-010-how-to-build-and-run.md rename to src/chap-010-how-to-build-and-run.md diff --git a/src/src/chap-020-running-tests.md b/src/chap-020-running-tests.md similarity index 100% rename from src/src/chap-020-running-tests.md rename to src/chap-020-running-tests.md diff --git a/src/src/chap-030-walkthrough.md b/src/chap-030-walkthrough.md similarity index 100% rename from src/src/chap-030-walkthrough.md rename to src/chap-030-walkthrough.md diff --git a/src/src/chap-040-compiler-conventions.md b/src/chap-040-compiler-conventions.md similarity index 100% rename from src/src/chap-040-compiler-conventions.md rename to src/chap-040-compiler-conventions.md diff --git a/src/src/chap-050-the-parser.md b/src/chap-050-the-parser.md similarity index 100% rename from src/src/chap-050-the-parser.md rename to src/chap-050-the-parser.md diff --git a/src/src/chap-060-macro-expansion.md b/src/chap-060-macro-expansion.md similarity index 100% rename from src/src/chap-060-macro-expansion.md rename to src/chap-060-macro-expansion.md diff --git a/src/src/chap-070-name-resolution.md b/src/chap-070-name-resolution.md similarity index 100% rename from src/src/chap-070-name-resolution.md rename to src/chap-070-name-resolution.md diff --git a/src/src/chap-080-hir-lowering.md b/src/chap-080-hir-lowering.md similarity index 100% rename from src/src/chap-080-hir-lowering.md rename to src/chap-080-hir-lowering.md diff --git a/src/src/chap-090-ty.md b/src/chap-090-ty.md similarity index 100% rename from src/src/chap-090-ty.md rename to src/chap-090-ty.md diff --git a/src/src/chap-100-type-inference.md b/src/chap-100-type-inference.md similarity index 100% rename from src/src/chap-100-type-inference.md rename to src/chap-100-type-inference.md diff --git a/src/src/chap-110-trait-resolution.md b/src/chap-110-trait-resolution.md similarity index 100% rename from src/src/chap-110-trait-resolution.md rename to src/chap-110-trait-resolution.md diff --git a/src/src/chap-120-type-checking.md b/src/chap-120-type-checking.md similarity index 100% rename from src/src/chap-120-type-checking.md rename to src/chap-120-type-checking.md diff --git a/src/src/chap-130-mir-construction.md b/src/chap-130-mir-construction.md similarity index 100% rename from src/src/chap-130-mir-construction.md rename to src/chap-130-mir-construction.md diff --git a/src/src/chap-140-mir-borrowck.md b/src/chap-140-mir-borrowck.md similarity index 100% rename from src/src/chap-140-mir-borrowck.md rename to src/chap-140-mir-borrowck.md diff --git a/src/src/chap-150-mir-optimizations.md b/src/chap-150-mir-optimizations.md similarity index 100% rename from src/src/chap-150-mir-optimizations.md rename to src/chap-150-mir-optimizations.md diff --git a/src/src/chap-160-trans.md b/src/chap-160-trans.md similarity index 100% rename from src/src/chap-160-trans.md rename to src/chap-160-trans.md diff --git a/src/src/glossary.md b/src/glossary.md similarity index 100% rename from src/src/glossary.md rename to src/glossary.md