about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorCamelid <camelidcamel@gmail.com>2021-01-10 13:19:39 -0800
committerGitHub <noreply@github.com>2021-01-10 16:19:39 -0500
commit5e3512a4c6b9085deb9dfb3cb293ded766765dea (patch)
treed3075450cd50ea658248211d6b567018da456d75 /src/doc/rustc-dev-guide
parent84c3c96d59eeeb1ceeccc31fdc36f8524b511b0d (diff)
downloadrust-5e3512a4c6b9085deb9dfb3cb293ded766765dea.tar.gz
rust-5e3512a4c6b9085deb9dfb3cb293ded766765dea.zip
Update 'Workspace structure' section (#1017)
* Update description of `src/`
* Note that `library/` also contains the Rust runtime
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/compiler-src.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/src/doc/rustc-dev-guide/src/compiler-src.md b/src/doc/rustc-dev-guide/src/compiler-src.md
index b26ede5799b..bcf169a133f 100644
--- a/src/doc/rustc-dev-guide/src/compiler-src.md
+++ b/src/doc/rustc-dev-guide/src/compiler-src.md
@@ -15,18 +15,24 @@ look at the structure of the contents of the rust-lang/rust repo.
 
 The `rust-lang/rust` repository consists of a single large cargo workspace
 containing the compiler, the standard libraries (`core`, `alloc`, `std`,
-`proc_macro`, etc), and `rustdoc`, along with the build system and bunch of
+`proc_macro`, etc), and `rustdoc`, along with the build system and a bunch of
 tools and submodules for building a full Rust distribution.
 
 As of this writing, this structure is gradually undergoing some transformation
 to make it a bit less monolithic and more approachable, especially to
 newcomers.
 
-The repository consists of a `src` directory, under which there live many
-crates, which are the source for the compiler, build system, tools, etc. This
-directory is currently being broken up to be less monolithic. There is also a
-`library/` directory, where the standard libraries (`core`, `alloc`, `std`,
-`proc_macro`, etc) live.
+The repository consists of three main directories:
+
+- `compiler/` contains the source code for `rustc`. It consists of many crates
+  that together make up the compiler.
+
+- `library/` contains the standard libraries (`core`, `alloc`, `std`,
+  `proc_macro`, `test`), as well as the Rust runtime (`backtrace`, `rtstartup`,
+  `lang_start`).
+
+- `src/` contains the source code for rustdoc, clippy, cargo, the build system,
+  language docs, etc.
 
 ## Standard library