diff options
| author | mark <markm@cs.wisc.edu> | 2020-07-20 19:42:01 -0500 |
|---|---|---|
| committer | Who? Me?! <mark-i-m@users.noreply.github.com> | 2020-08-02 19:44:04 -0500 |
| commit | b6554ff04798cc57745560f03a10cefc91a32a6c (patch) | |
| tree | 0ceaa870acbfa34f0c265f89d480ce8e1db9463a /src/doc/rustc-dev-guide | |
| parent | 23f72438e0c32d1d4145fe25a31e7346ac721380 (diff) | |
| download | rust-b6554ff04798cc57745560f03a10cefc91a32a6c.tar.gz rust-b6554ff04798cc57745560f03a10cefc91a32a6c.zip | |
mention the overview chapter
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/compiler-src.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/compiler-src.md b/src/doc/rustc-dev-guide/src/compiler-src.md index 67940d367df..a9d708f1a88 100644 --- a/src/doc/rustc-dev-guide/src/compiler-src.md +++ b/src/doc/rustc-dev-guide/src/compiler-src.md @@ -5,6 +5,9 @@ > top-level directory has separate directories for the compiler, build-system, > std libs, etc, rather than one huge `src/` directory. +Now that we have [seen what the compiler does](./overview.md), let's take a +look at the structure of the contents of the rust-lang/rust repo. + ## Workspace structure The `rust-lang/rust` repository consists of a single large cargo workspace @@ -35,6 +38,10 @@ built in a special way because it can use unstable features. ## Compiler +> You may find it helpful to read [The Overview Chapter](./overview.md) first, +> which gives an overview of how the compiler works. The crates mentioned in +> this section implement the compiler. + The compiler crates all have names starting with `librustc_*`. These are a large collection of interdependent crates. There is also the `rustc` crate which is the actual binary. It doesn't actually do anything besides calling the compiler |
