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.

Sign up for GitHub

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

Correct the wrong serial number #1147

Merged
merged 3 commits into from
Jun 23, 2021
Merged

Correct the wrong serial number #1147

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5aef621
Delete the wrong serial number
Rustin170506 Jun 23, 2021
30a3d00
Address comment
Rustin170506 Jun 23, 2021
2463876
Adjustment sequence
Rustin170506 Jun 23, 2021
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
16 changes: 8 additions & 8 deletions src/about-this-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@ This guide is meant to help document how rustc – the Rust compiler –
works, as well as to help new contributors get involved in rustc
development.

There are six parts to this guide:
There are seven parts to this guide:

1. [Building and debugging `rustc`][p1]: Contains information that should be
useful no matter how you are contributing, about building, debugging,
profiling, etc.
2. [Contributing to `rustc`][p1-5]: Contains information that should be useful
2. [Contributing to `rustc`][contributing]: Contains information that should be useful
Copy link
Member

Choose a reason for hiding this comment

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

nit: I'd like to keep the consistency of the links here. I mean, the chapter name vs. the chapter number. I'm fine either way.

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually I'm not quite sure which chapter p1-5 is referring to? I'm not quite sure what chapter number to use in this place.

Copy link
Member

Choose a reason for hiding this comment

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

I guess it was considered as a subchapter? It explains why it said "six chapters". But now it has its own chapter so it should make sense to call it p2.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed.

no matter how you are contributing, about procedures for contribution, using git
and Github, stabilizing features, etc.
2. [High-Level Compiler Architecture][p2]: Discusses the high-level
3. [High-Level Compiler Architecture][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
4. [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
5. [Analysis][p4]: discusses the analyses that the compiler uses to check various
properties of the code and inform later stages of the compile process (e.g., type checking).
5. [From MIR to Binaries][p5]: How linked executable machine code is generated.
6. [Appendices][app] at the end with useful reference information. There are a
6. [From MIR to Binaries][p5]: How linked executable machine code is generated.
7. [Appendices][app] at the end with useful reference information. There are a
few of these with different information, including a glossary.

[p1]: ./getting-started.md
[p1-5]: ./compiler-team.md
[contributing]: ./contributing.md
[p2]: ./part-2-intro.md
[p3]: ./part-3-intro.md
[p4]: ./part-4-intro.md
Expand Down