Skip to content

Commit 8375007

Browse files
committed
Reorganize the book into 3 parts
1 parent e900144 commit 8375007

File tree

4 files changed

+41
-10
lines changed

4 files changed

+41
-10
lines changed

src/SUMMARY.md

+17-10
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,28 @@
11
# Summary
22

3-
- [About this guide](./about-this-guide.md)
3+
[About this guide](./about-this-guide.md)
4+
5+
---
6+
7+
- [Part 1 Intro](./part-1-intro.md)
48
- [About the compiler team](./compiler-team.md)
59
- [How to build the compiler and run what you built](./how-to-build-and-run.md)
610
- [Build and Install distribution artifacts](./build-install-distribution-artifacts.md)
711
- [Documenting Compiler](./compiler-documenting.md)
8-
- [Coding conventions](./conventions.md)
9-
- [Stabilizing Features](./stabilization_guide.md)
10-
- [Walkthrough: a typical contribution](./walkthrough.md)
1112
- [The compiler testing framework](./tests/intro.md)
1213
- [Running tests](./tests/running.md)
1314
- [Adding new tests](./tests/adding.md)
14-
- [Using `compiletest` + commands to control test
15-
execution](./compiletest.md)
15+
- [Using `compiletest` + commands to control test execution](./compiletest.md)
16+
- [Walkthrough: a typical contribution](./walkthrough.md)
17+
- [Stabilizing Features](./stabilization_guide.md)
1618
- [Debugging the Compiler](./compiler-debugging.md)
1719
- [Profiling the compiler](./profiling.md)
1820
- [with the linux perf tool](./profiling/with_perf.md)
21+
- [Coding conventions](./conventions.md)
22+
23+
---
24+
25+
- [Part 2 Intro](./part-2-intro.md)
1926
- [High-level overview of the compiler source](./high-level-overview.md)
2027
- [The Rustc Driver](./rustc-driver.md)
2128
- [Rustdoc](./rustdoc.md)
@@ -71,7 +78,7 @@
7178

7279
---
7380

74-
- [Appendix A: Stupid Stats](./appendix/stupid-stats.md)
75-
- [Appendix B: Background material](./appendix/background.md)
76-
- [Appendix C: Glossary](./appendix/glossary.md)
77-
- [Appendix D: Code Index](./appendix/code-index.md)
81+
[Appendix A: Stupid Stats](./appendix/stupid-stats.md)
82+
[Appendix B: Background material](./appendix/background.md)
83+
[Appendix C: Glossary](./appendix/glossary.md)
84+
[Appendix D: Code Index](./appendix/code-index.md)

src/about-this-guide.md

+5
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ development. It is not meant to replace code documentation – each
66
chapter gives only high-level details – the kinds of things that
77
(ideally) don't change frequently.
88

9+
There are three parts to this guide. Part 1 contains information that should
10+
be useful no matter how you are contributing. Part 2 contains information
11+
about how the compiler works. Finally, there are some appendices at the
12+
end with useful reference information.
13+
914
The guide itself is of course open-source as well, and the sources can
1015
be found at the [GitHub repository]. If you find any mistakes in the
1116
guide, please file an issue about it, or even better, open a PR

src/part-1-intro.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Part 1: General Knowledge
2+
3+
This section of the rustc-guide contains knowledge that should be useful to you
4+
regardless of what part of the compiler you are working on. This includes both
5+
technical info and tips (e.g. how to compile and debug the compiler) and info
6+
about processes in the Rust project (e.g. stabilization and info about the
7+
compiler team).

src/part-2-intro.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Part 2: How rustc works
2+
3+
This part of the guide describes how the compiler works. It goes through
4+
everything from high-level structure of the compiler to how each stage of
5+
compilation works.
6+
7+
This section should be friendly to both readers interested in the end-to-end
8+
process of compilation _and_ readers interested in learning about a specific
9+
system they wish to contribute to. If anything is unclear, feel free to file
10+
an issue on the [rustc-guide repo](https://github.com/rust-lang/rustc-guide)
11+
or contact the compiler team, as detailed in [this chapter from Part
12+
1](./compiler-team.md).

0 commit comments

Comments
 (0)