Skip to content

Update 'Workspace structure' section #1017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 10, 2021
Merged

Update 'Workspace structure' section #1017

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ea68915
Update 'Workspace structure' section
camelid Jan 10, 2021
9e62cff
Update description of `src/`
camelid Jan 10, 2021
76605f9
Note that `library/` also contains the Rust runtime
camelid Jan 10, 2021
544d719
Fixup
camelid Jan 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions src/compiler-src.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down