about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authormark <markm@cs.wisc.edu>2019-01-18 15:16:13 -0600
committerWho? Me?! <mark-i-m@users.noreply.github.com>2019-01-18 15:51:53 -0600
commita0badea0c7ecddb45d5b5c93607f46689100dad5 (patch)
tree9b4dd142b672a9b09449d27a605ce3698842d6c6 /src/doc/rustc-dev-guide
parente709d9bfcc008ea89d7a8963b335ebc6dde90291 (diff)
Reorganize the book into 3 parts
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/SUMMARY.md27
-rw-r--r--src/doc/rustc-dev-guide/src/about-this-guide.md5
-rw-r--r--src/doc/rustc-dev-guide/src/part-1-intro.md7
-rw-r--r--src/doc/rustc-dev-guide/src/part-2-intro.md12
4 files changed, 41 insertions, 10 deletions
diff --git a/src/doc/rustc-dev-guide/src/SUMMARY.md b/src/doc/rustc-dev-guide/src/SUMMARY.md
index 9bdf892785c..a17a3c6a089 100644
--- a/src/doc/rustc-dev-guide/src/SUMMARY.md
+++ b/src/doc/rustc-dev-guide/src/SUMMARY.md
@@ -1,21 +1,28 @@
 # Summary
 
-- [About this guide](./about-this-guide.md)
+[About this guide](./about-this-guide.md)
+
+---
+
+- [Part 1 Intro](./part-1-intro.md)
 - [About the compiler team](./compiler-team.md)
 - [How to build the compiler and run what you built](./how-to-build-and-run.md)
     - [Build and Install distribution artifacts](./build-install-distribution-artifacts.md)
     - [Documenting Compiler](./compiler-documenting.md)
-- [Coding conventions](./conventions.md)
-- [Stabilizing Features](./stabilization_guide.md)
-- [Walkthrough: a typical contribution](./walkthrough.md)
 - [The compiler testing framework](./tests/intro.md)
     - [Running tests](./tests/running.md)
     - [Adding new tests](./tests/adding.md)
-    - [Using `compiletest` + commands to control test
-      execution](./compiletest.md)
+    - [Using `compiletest` + commands to control test execution](./compiletest.md)
+- [Walkthrough: a typical contribution](./walkthrough.md)
+- [Stabilizing Features](./stabilization_guide.md)
 - [Debugging the Compiler](./compiler-debugging.md)
 - [Profiling the compiler](./profiling.md)
     - [with the linux perf tool](./profiling/with_perf.md)
+- [Coding conventions](./conventions.md)
+
+---
+
+- [Part 2 Intro](./part-2-intro.md)
 - [High-level overview of the compiler source](./high-level-overview.md)
 - [The Rustc Driver](./rustc-driver.md)
     - [Rustdoc](./rustdoc.md)
@@ -71,7 +78,7 @@
 
 ---
 
-- [Appendix A: Stupid Stats](./appendix/stupid-stats.md)
-- [Appendix B: Background material](./appendix/background.md)
-- [Appendix C: Glossary](./appendix/glossary.md)
-- [Appendix D: Code Index](./appendix/code-index.md)
+[Appendix A: Stupid Stats](./appendix/stupid-stats.md)
+[Appendix B: Background material](./appendix/background.md)
+[Appendix C: Glossary](./appendix/glossary.md)
+[Appendix D: Code Index](./appendix/code-index.md)
diff --git a/src/doc/rustc-dev-guide/src/about-this-guide.md b/src/doc/rustc-dev-guide/src/about-this-guide.md
index 56f0b7538a7..30a3b88708f 100644
--- a/src/doc/rustc-dev-guide/src/about-this-guide.md
+++ b/src/doc/rustc-dev-guide/src/about-this-guide.md
@@ -6,6 +6,11 @@ development. It is not meant to replace code documentation – each
 chapter gives only high-level details – the kinds of things that
 (ideally) don't change frequently.
 
+There are three parts to this guide. Part 1 contains information that should
+be useful no matter how you are contributing. Part 2 contains information
+about how the compiler works. Finally, there are some appendices at the
+end with useful reference information.
+
 The guide itself is of course open-source as well, and the sources can
 be found at the [GitHub repository]. If you find any mistakes in the
 guide, please file an issue about it, or even better, open a PR
diff --git a/src/doc/rustc-dev-guide/src/part-1-intro.md b/src/doc/rustc-dev-guide/src/part-1-intro.md
new file mode 100644
index 00000000000..c829f8c3bd3
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/part-1-intro.md
@@ -0,0 +1,7 @@
+# Part 1: General Knowledge
+
+This section of the rustc-guide contains knowledge that should be useful to you
+regardless of what part of the compiler you are working on. This includes both
+technical info and tips (e.g. how to compile and debug the compiler) and info
+about processes in the Rust project (e.g. stabilization and info about the
+compiler team).
diff --git a/src/doc/rustc-dev-guide/src/part-2-intro.md b/src/doc/rustc-dev-guide/src/part-2-intro.md
new file mode 100644
index 00000000000..6dd26f44cc1
--- /dev/null
+++ b/src/doc/rustc-dev-guide/src/part-2-intro.md
@@ -0,0 +1,12 @@
+# Part 2: How rustc works
+
+This part of the guide describes how the compiler works. It goes through
+everything from high-level structure of the compiler to how each stage of
+compilation works.
+
+This section should be friendly to both readers interested in the end-to-end
+process of compilation _and_ readers interested in learning about a specific
+system they wish to contribute to. If anything is unclear, feel free to file
+an issue on the [rustc-guide repo](https://github.com/rust-lang/rustc-guide)
+or contact the compiler team, as detailed in [this chapter from Part
+1](./compiler-team.md).