Skip to content

Commit e7ac2ff

Browse files
authored
Update 'Workspace structure' section (#1017)
* Update description of `src/` * Note that `library/` also contains the Rust runtime
1 parent d87e197 commit e7ac2ff

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

src/compiler-src.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,24 @@ look at the structure of the contents of the rust-lang/rust repo.
1515

1616
The `rust-lang/rust` repository consists of a single large cargo workspace
1717
containing the compiler, the standard libraries (`core`, `alloc`, `std`,
18-
`proc_macro`, etc), and `rustdoc`, along with the build system and bunch of
18+
`proc_macro`, etc), and `rustdoc`, along with the build system and a bunch of
1919
tools and submodules for building a full Rust distribution.
2020

2121
As of this writing, this structure is gradually undergoing some transformation
2222
to make it a bit less monolithic and more approachable, especially to
2323
newcomers.
2424

25-
The repository consists of a `src` directory, under which there live many
26-
crates, which are the source for the compiler, build system, tools, etc. This
27-
directory is currently being broken up to be less monolithic. There is also a
28-
`library/` directory, where the standard libraries (`core`, `alloc`, `std`,
29-
`proc_macro`, etc) live.
25+
The repository consists of three main directories:
26+
27+
- `compiler/` contains the source code for `rustc`. It consists of many crates
28+
that together make up the compiler.
29+
30+
- `library/` contains the standard libraries (`core`, `alloc`, `std`,
31+
`proc_macro`, `test`), as well as the Rust runtime (`backtrace`, `rtstartup`,
32+
`lang_start`).
33+
34+
- `src/` contains the source code for rustdoc, clippy, cargo, the build system,
35+
language docs, etc.
3036

3137
## Standard library
3238

0 commit comments

Comments
 (0)