Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"About This Guide" updates following Guide reorganization #671

Merged
merged 3 commits into from
Apr 7, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions src/about-this-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ development.

There are six parts to this guide:

1. [Contributing][p1]: Contains information that should be useful no matter how
1. [Building, Debugging, and Contributing to `rustc`][p1]: Contains information that should be useful no matter how
you are contributing, such as procedures for contribution, building the
compiler, etc.
2. [High-level Compiler Architecture][p2]: Discusses the high-level
architecture of the compiler, especially the query system.
3. [The Compiler Frontend][p3]: Discusses the compiler frontend and internal
representations.
4. [The Type System][p4]: Discusses the type system.
5. [The Compiler Backend][p5]: Discusses the compiler backend, code generation,
linking, and debug info.
2. [How `rustc` Works][p2]: Discusses the high-level
architecture of the compiler and stages of the compile process
3. [Source Code Representation][p3]: Describes the process of taking raw source code from the user and
transforming it into various forms that the compiler can work with easily
4. [Analysis][p4]: discusses the analyses that the compiler uses to check various
properties of the code and inform later stages of the compile process
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps add "(e.g., type checking)”

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

5. [From MIR to Binaries][p5]: How linked executable machine code is generated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nit: can you end each point with a period?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem! Will add them now.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

6. [Appendices][app] at the end with useful reference information. There are a
few of these with different information, inluding a glossary.

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

The guide itself is of course open-source as well, and the sources can
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
with a correction!
Expand All @@ -35,12 +35,12 @@ with a correction!

You might also find the following sites useful:

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

[GitHub repository]: https://github.com/rust-lang/rustc-dev-guide/
[Rustc API docs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/
[rustc API docs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_middle/
[Forge]: https://forge.rust-lang.org/
[compiler-team]: https://github.com/rust-lang/compiler-team/
2 changes: 1 addition & 1 deletion src/part-1-intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Part 1: Building, debugging, and contributing to Rustc
# Part 1: Building, Debugging, and Contributing to `rustc`

This section of the rustc-dev-guide contains knowledge that should be useful to you
regardless of what part of the compiler you are working on. This includes both
Expand Down
2 changes: 1 addition & 1 deletion src/part-2-intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Part 2: How rustc works
# Part 2: How `rustc` Works
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm... I think high-level compiler arch is actually a better name (also in the about this guode section).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


The remaining parts of this guide discuss how the compiler works. They go
through everything from high-level structure of the compiler to how each stage
Expand Down
2 changes: 1 addition & 1 deletion src/part-5-intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# From MIR to binaries
# From MIR to Binaries

All of the preceding chapters of this guide have one thing in common: we never
generated any executable machine code at all! With this chapter, all of that
Expand Down