summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorpierwill <pierwill@users.noreply.github.com>2021-10-28 11:41:04 -0500
committerJoshua Nelson <github@jyn.dev>2021-10-28 15:30:08 -0500
commit52a1d9b4f6f6d6e4b7110335d153cf0785abf115 (patch)
tree7c45b8351a4cc5794be51b5c8ef9f65cfa5d2cb6 /src/doc/rustc-dev-guide
parent16ce294eb9b78601dd38979ca637024d0444bf67 (diff)
downloadrust-52a1d9b4f6f6d6e4b7110335d153cf0785abf115.tar.gz
rust-52a1d9b4f6f6d6e4b7110335d153cf0785abf115.zip
Edit "About this guide" for semantic line feeds
This is work toward #1241.
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/about-this-guide.md60
1 files changed, 31 insertions, 29 deletions
diff --git a/src/doc/rustc-dev-guide/src/about-this-guide.md b/src/doc/rustc-dev-guide/src/about-this-guide.md
index 3fa397ae408..f4c5c81d1b3 100644
--- a/src/doc/rustc-dev-guide/src/about-this-guide.md
+++ b/src/doc/rustc-dev-guide/src/about-this-guide.md
@@ -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
@@ -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