From ea689156f2828ed1f57b70390518e3779d52b570 Mon Sep 17 00:00:00 2001 From: Camelid Date: Sat, 9 Jan 2021 21:58:12 -0800 Subject: [PATCH 1/4] Update 'Workspace structure' section --- src/compiler-src.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/src/compiler-src.md b/src/compiler-src.md index b26ede579..232c699de 100644 --- a/src/compiler-src.md +++ b/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`, etc.). + +- `src/` contains the source code for the build system, tools like clippy and + cargo, language docs, etc. This directory is currently being broken up to be + less monolithic. ## Standard library From 9e62cff6d61df16d03a78ac182b15660b0e84c30 Mon Sep 17 00:00:00 2001 From: Camelid Date: Sun, 10 Jan 2021 11:33:49 -0800 Subject: [PATCH 2/4] Update description of `src/` --- src/compiler-src.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/src/compiler-src.md b/src/compiler-src.md index 232c699de..bbfe0b5af 100644 --- a/src/compiler-src.md +++ b/src/compiler-src.md @@ -30,9 +30,8 @@ The repository consists of three main directories: - `library/` contains the standard libraries (`core`, `alloc`, `std`, `proc_macro`, etc.). -- `src/` contains the source code for the build system, tools like clippy and - cargo, language docs, etc. This directory is currently being broken up to be - less monolithic. +- `src/` contains the source code for rustdoc, clippy, cargo, the build system, + language docs, etc. ## Standard library From 76605f9324396a11062334614e7af67cf128e562 Mon Sep 17 00:00:00 2001 From: Camelid Date: Sun, 10 Jan 2021 12:59:43 -0800 Subject: [PATCH 3/4] Note that `library/` also contains the Rust runtime Co-authored-by: Joshua Nelson --- src/compiler-src.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/compiler-src.md b/src/compiler-src.md index bbfe0b5af..fd6a8f6e3 100644 --- a/src/compiler-src.md +++ b/src/compiler-src.md @@ -28,7 +28,7 @@ The repository consists of three main directories: that together make up the compiler. - `library/` contains the standard libraries (`core`, `alloc`, `std`, -`proc_macro`, etc.). +`proc_macro`, etc.), 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. From 544d719fc8ba5651047ac1c27c0913c91a194abf Mon Sep 17 00:00:00 2001 From: Camelid Date: Sun, 10 Jan 2021 13:00:54 -0800 Subject: [PATCH 4/4] Fixup --- src/compiler-src.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/compiler-src.md b/src/compiler-src.md index fd6a8f6e3..bcf169a13 100644 --- a/src/compiler-src.md +++ b/src/compiler-src.md @@ -28,7 +28,8 @@ The repository consists of three main directories: that together make up the compiler. - `library/` contains the standard libraries (`core`, `alloc`, `std`, -`proc_macro`, etc.), as well as the Rust runtime (`backtrace`, `rtstartup`, `lang_start`). + `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.