about summary refs log tree commit diff
path: root/src/doc
diff options
context:
space:
mode:
authormark <markm@cs.wisc.edu>2020-04-04 13:20:48 -0500
committerWho? Me?! <mark-i-m@users.noreply.github.com>2020-04-18 11:11:33 -0500
commit887c4572661cd13c846b7f4c25b15474aea48cb4 (patch)
tree492d6c9c9a24a490546125f436d9dee6a207e095 /src/doc
parent411ab09d62ca6bec427ff742a8b6dc6e90f3f34b (diff)
downloadrust-887c4572661cd13c846b7f4c25b15474aea48cb4.tar.gz
rust-887c4572661cd13c846b7f4c25b15474aea48cb4.zip
line lengths
Diffstat (limited to 'src/doc')
-rw-r--r--src/doc/rustc-dev-guide/src/overview.md24
1 files changed, 19 insertions, 5 deletions
diff --git a/src/doc/rustc-dev-guide/src/overview.md b/src/doc/rustc-dev-guide/src/overview.md
index 350ff5523c0..26f7a2ad13a 100644
--- a/src/doc/rustc-dev-guide/src/overview.md
+++ b/src/doc/rustc-dev-guide/src/overview.md
@@ -19,11 +19,25 @@ we'll talk about that later.
 
 **TODO: someone else should confirm this vvv**
 
-- The compile process begins when a user writes a Rust source program in text and invokes the `rustc` compiler on it. The work that the compiler needs to perform is defined by command-line options. For example, it is possible to enable nightly features (`-Z` flags), perform `check`-only builds, or emit LLVM-IR rather than executable machine code. The `rustc` executable call may be indirect through the use of `cargo`.
-- Command line argument parsing occurs in the [`librustc_driver`]. This crate defines the compile configuration that is requested by the user and passes it to the rest of the compilation process as a [`rustc_interface::Config`].
-- The raw Rust source text is analyzed by a low-level lexer located in [`librustc_lexer`]. At this stage, the source text is turned into a stream of atomic source code units known as _tokens_. (**TODO**: chrissimpkins - Maybe discuss Unicode handling during this stage?)
-- The token stream passes through a higher-level lexer located in [`librustc_parse`] to prepare for the next stage of the compile process. The [`StringReader`] struct is used at this stage to perform a set of validations and turn strings into interned symbols.
-- (**TODO**: chrissimpkins - Expand info on parser) We then [_parse_ the stream of tokens][parser] to build an Abstract Syntax Tree (AST).
+- The compile process begins when a user writes a Rust source program in text
+  and invokes the `rustc` compiler on it. The work that the compiler needs to
+  perform is defined by command-line options. For example, it is possible to
+  enable nightly features (`-Z` flags), perform `check`-only builds, or emit
+  LLVM-IR rather than executable machine code. The `rustc` executable call may
+  be indirect through the use of `cargo`.
+- Command line argument parsing occurs in the [`librustc_driver`]. This crate
+  defines the compile configuration that is requested by the user and passes it
+  to the rest of the compilation process as a [`rustc_interface::Config`].
+- The raw Rust source text is analyzed by a low-level lexer located in
+  [`librustc_lexer`]. At this stage, the source text is turned into a stream of
+  atomic source code units known as _tokens_. (**TODO**: chrissimpkins - Maybe
+  discuss Unicode handling during this stage?)
+- The token stream passes through a higher-level lexer located in
+  [`librustc_parse`] to prepare for the next stage of the compile process. The
+  [`StringReader`] struct is used at this stage to perform a set of validations
+  and turn strings into interned symbols.
+- (**TODO**: chrissimpkins - Expand info on parser) We then [_parse_ the stream
+  of tokens][parser] to build an Abstract Syntax Tree (AST).
   - macro expansion (**TODO** chrissimpkins)
   - ast validation (**TODO** chrissimpkins)
   - nameres (**TODO** chrissimpkins)