mirror
/
rustc-dev-guide
mirror of https://github.com/rust-lang/rustc-dev-guide.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Edit "About this guide" for semantic line feeds 

This is work toward #1241.
This commit is contained in:
pierwill 2021-10-28 11:41:04 -05:00 committed by Joshua Nelson
parent ddaebd85aa
commit f3fb373be9
1 changed files with 31 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
src/about-this-guide.md
View File

@ -1,26 +1,27 @@
# About this guide # About this guide
This guide is meant to help document how rustc – the Rust compiler – This guide is meant to help document how rustc – the Rust compiler – works,
works, as well as to help new contributors get involved in rustc as well as to help new contributors get involved in rustc development.
development.
There are seven parts to this guide: There are seven parts to this guide:
1. [Building and debugging `rustc`][p1]: Contains information that should be 1. [Building and debugging `rustc`][p1]:
useful no matter how you are contributing, about building, debugging, Contains information that should be useful no matter how you are contributing,
profiling, etc. about building, debugging, profiling, etc.
2. [Contributing to `rustc`][p2]: Contains information that should be useful 2. [Contributing to `rustc`][p2]:
no matter how you are contributing, about procedures for contribution, using git Contains information that should be useful no matter how you are contributing,
and Github, stabilizing features, etc. about procedures for contribution, using git and Github, stabilizing features, etc.
3. [High-Level Compiler Architecture][p3]: Discusses the high-level 3. [High-Level Compiler Architecture][p3]:
architecture of the compiler and stages of the compile process. 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 4. [Source Code Representation][p4]:
transforming it into various forms that the compiler can work with easily. Describes the process of taking raw source code from the user
5. [Analysis][p5]: discusses the analyses that the compiler uses to check various and transforming it into various forms that the compiler can work with easily.
properties of the code and inform later stages of the compile process (e.g., type checking). 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. 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 7. [Appendices][p7] at the end with useful reference information.
few of these with different information, including a glossary. There are a few of these with different information, including a glossary.
[p1]: ./getting-started.md [p1]: ./getting-started.md
[p2]: ./contributing.md [p2]: ./contributing.md
@ -32,25 +33,26 @@ There are seven parts to this guide:
### Constant change ### Constant change
Keep in mind that `rustc` is a real production-quality product, being worked upon continuously by a Keep in mind that `rustc` is a real production-quality product,
sizeable set of contributors. being worked upon continuously by a sizeable set of contributors.
As such, it has its fair share of codebase churn and technical debt. 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 In addition, many of the ideas discussed throughout this guide are idealized designs
fully realized yet. that are not fully realized yet.
All this makes keeping this guide completely up to date on everything very hard! 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 The Guide itself is of course open-source as well,
[GitHub repository]. 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 If you find any mistakes in the guide, please file an issue about it.
a correction! even better, open a PR with a correction!
If you do contribute to the guide, please see the corresponding If you do contribute to the guide,
[subsection on writing documentation in this 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 [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 > “‘All conditioned things are impermanent’ —
> suffering.” _The Dhammapada, verse 277_ > when one sees this with wisdom, one turns away from suffering.”
> _The Dhammapada, verse 277_
## Other places to find information ## Other places to find information