Skip to content

Edit "About this guide" for semantic line feeds #1243

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

Merged
merged 1 commit into from
Oct 28, 2021
Merged
Changes from all 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
60 changes: 31 additions & 29 deletions src/about-this-guide.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
# About this guide

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.
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 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`][p2]: Contains information that should be useful
no matter how you are contributing, about procedures for contribution, using git
and Github, stabilizing features, etc.
3. [High-Level Compiler Architecture][p3]: Discusses the high-level
architecture of the compiler and stages of the compile process.
4. [Source Code Representation][p4]: Describes the process of taking raw source code from the user and
transforming it into various forms that the compiler can work with easily.
5. [Analysis][p5]: 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).
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`][p2]:
Contains information that should be useful no matter how you are contributing,
about procedures for contribution, using git and Github, stabilizing features, etc.
3. [High-Level Compiler Architecture][p3]:
Discusses the high-level architecture of the compiler and stages of the compile process.
4. [Source Code Representation][p4]:
Describes the process of taking raw source code from the user
and transforming it into various forms that the compiler can work with easily.
5. [Analysis][p5]:
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).
6. [From MIR to Binaries][p6]: How linked executable machine code is generated.
7. [Appendices][p7] at the end with useful reference information. There are a
few of these with different information, including a glossary.
7. [Appendices][p7] at the end with useful reference information.
There are a few of these with different information, including a glossary.

[p1]: ./getting-started.md
[p2]: ./contributing.md
Expand All @@ -32,25 +33,26 @@ There are seven parts to this guide:

### Constant change

Keep in mind that `rustc` is a real production-quality product, being worked upon continuously by a
sizeable set of contributors.
Keep in mind that `rustc` is a real production-quality product,
being worked upon continuously by a sizeable set of contributors.
As such, it has its fair share of codebase churn and technical debt.
In addition, many of the ideas discussed throughout this guide are idealized designs that are not
fully realized yet.
In addition, many of the ideas discussed throughout this guide are idealized designs
that are not fully realized yet.
All this makes keeping this guide completely up to date on everything very hard!

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!
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.
even better, open a PR with a correction!

If you do contribute to the guide, please see the corresponding
[subsection on writing documentation in this guide].
If you do contribute to the guide,
please see the corresponding [subsection on writing documentation in this guide].

[subsection on writing documentation in this guide]: contributing.md#contributing-to-rustc-dev-guide

> “‘All conditioned things are impermanent’ — when one sees this with wisdom, one turns away from
> suffering.” _The Dhammapada, verse 277_
> “‘All conditioned things are impermanent’ —
> when one sees this with wisdom, one turns away from suffering.”
> _The Dhammapada, verse 277_

## Other places to find information

Expand Down