Skip to content

Commit daa1d91

Browse files
chrissimpkinsmark-i-m
authored andcommitted
update about-this-guide.md with new Guide sections
1 parent 269b5f0 commit daa1d91

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

src/about-this-guide.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ development.
66

77
There are six parts to this guide:
88

9-
1. [Contributing][p1]: Contains information that should be useful no matter how
9+
1. [Building, Debugging, and Contributing to `rustc`][p1]: Contains information that should be useful no matter how
1010
you are contributing, such as procedures for contribution, building the
1111
compiler, etc.
12-
2. [High-level Compiler Architecture][p2]: Discusses the high-level
13-
architecture of the compiler, especially the query system.
14-
3. [The Compiler Frontend][p3]: Discusses the compiler frontend and internal
15-
representations.
16-
4. [The Type System][p4]: Discusses the type system.
17-
5. [The Compiler Backend][p5]: Discusses the compiler backend, code generation,
18-
linking, and debug info.
12+
2. [How `rustc` Works][p2]: Discusses the high-level
13+
architecture of the compiler and stages of the compile process
14+
3. [Source Code Representation][p3]: Describes the process of taking raw source code from the user and
15+
transforming it into various forms that the compiler can work with easily
16+
4. [Analysis][p4]: discusses the analyses that the compiler uses to check various
17+
properties of the code and inform later stages of the compile process
18+
5. [From MIR to Binaries][p5]: How linked executable machine code is generated
1919
6. [Appendices][app] at the end with useful reference information. There are a
2020
few of these with different information, inluding a glossary.
2121

@@ -26,7 +26,7 @@ There are six parts to this guide:
2626
[p5]: ./part-5-intro.md
2727
[app]: ./appendix/background.md
2828

29-
The guide itself is of course open-source as well, and the sources can
29+
The Guide itself is of course open-source as well, and the sources can
3030
be found at the [GitHub repository]. If you find any mistakes in the
3131
guide, please file an issue about it, or even better, open a PR
3232
with a correction!
@@ -35,12 +35,12 @@ with a correction!
3535

3636
You might also find the following sites useful:
3737

38-
- [Rustc API docs] -- rustdoc documentation for the compiler
38+
- [rustc API docs] -- rustdoc documentation for the compiler
3939
- [Forge] -- contains documentation about rust infrastructure, team procedures, and more
4040
- [compiler-team] -- the home-base for the rust compiler team, with description
4141
of the team procedures, active working groups, and the team calendar.
4242

4343
[GitHub repository]: https://github.com/rust-lang/rustc-dev-guide/
44-
[Rustc API docs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/
44+
[rustc API docs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/
4545
[Forge]: https://forge.rust-lang.org/
4646
[compiler-team]: https://github.com/rust-lang/compiler-team/

0 commit comments

Comments
 (0)