Skip to content

Commit a05c553

Browse files
committed
Start moving to the rustc guide!
1 parent 27a046e commit a05c553

File tree

10 files changed

+21
-1291
lines changed

10 files changed

+21
-1291
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -623,6 +623,7 @@ For people new to Rust, and just starting to contribute, or even for
623623
more seasoned developers, some useful places to look for information
624624
are:
625625

626+
* The [rustc guide] contains information about how various parts of the compiler work
626627
* [Rust Forge][rustforge] contains additional documentation, including write-ups of how to achieve common tasks
627628
* The [Rust Internals forum][rif], a place to ask questions and
628629
discuss Rust's internals
@@ -635,6 +636,7 @@ are:
635636
* **Google!** ([search only in Rust Documentation][gsearchdocs] to find types, traits, etc. quickly)
636637
* Don't be afraid to ask! The Rust community is friendly and helpful.
637638

639+
[rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/about-this-guide.html
638640
[gdfrustc]: http://manishearth.github.io/rust-internals-docs/rustc/
639641
[gsearchdocs]: https://www.google.com/search?q=site:doc.rust-lang.org+your+query+here
640642
[rif]: http://internals.rust-lang.org

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,9 +227,13 @@ variety of channels on Mozilla's IRC network, irc.mozilla.org. The
227227
most popular channel is [#rust], a venue for general discussion about
228228
Rust. And a good place to ask for help would be [#rust-beginners].
229229

230+
Also, the [rustc guide] might be a good place to start if you want to
231+
find out how various parts of the compiler work.
232+
230233
[IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat
231234
[#rust]: irc://irc.mozilla.org/rust
232235
[#rust-beginners]: irc://irc.mozilla.org/rust-beginners
236+
[rustc-guide]: https://rust-lang-nursery.github.io/rustc-guide/about-this-guide.html
233237

234238
## License
235239
[license]: #license

src/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
This directory contains the source code of the rust project, including:
2+
- `rustc` and its tests
3+
- `libstd`
4+
- Various submodules for tools, like rustdoc, rls, etc.
5+
6+
For more information on how various parts of the compiler work, see the [rustc guide].
7+
8+
Their is also useful content in the following READMEs, which are gradually being moved over to the guide:
9+
- https://github.com/rust-lang/rust/tree/master/src/librustc/ty/maps
10+
- https://github.com/rust-lang/rust/tree/master/src/librustc/dep_graph
11+
- https://github.com/rust-lang/rust/blob/master/src/librustc/infer/region_constraints
12+
- https://github.com/rust-lang/rust/tree/master/src/librustc/infer/higher_ranked
13+
- https://github.com/rust-lang/rust/tree/master/src/librustc/infer/lexical_region_resolve
14+
15+
[rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/about-this-guide.html

src/librustc/README.md

Lines changed: 0 additions & 204 deletions
This file was deleted.

src/librustc/hir/README.md

Lines changed: 0 additions & 119 deletions
This file was deleted.

src/librustc/hir/map/README.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)