Skip to content

Commit c0569d6

Browse files
authored
Merge pull request #537 from mark-i-m/rename
Rename rustc-guide -> rustc-dev-guide
2 parents bb71917 + 1d65c4c commit c0569d6

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
layout: post
3+
title: "The rustc-guide is now rustc-dev-guide"
4+
author: mark-i-m
5+
description: "the guide has been renamed"
6+
team: the rustc learning working group <https://www.rust-lang.org/governance/teams/compiler#wg-learning>
7+
---
8+
9+
You may or may not be aware of two similarly named resources:
10+
- [The rustc book](https://doc.rust-lang.org/rustc/index.html)
11+
- [The rustc-guide](https://rustc-dev-guide.rust-lang.org/)
12+
13+
What's the difference? The "rustc book" is intended as a guide for _users_ of the
14+
compiler. The "rustc-guide" is intended as a guide for _developers_ of the
15+
compiler. However, the names have always been confusingly similar.
16+
17+
**For that reason, we have decided to rename the `rustc-guide` to
18+
`rustc-dev-guide`. You can now find it at [https://rustc-dev-guide.rust-lang.org/][guide].**
19+
20+
[guide]: https://rustc-dev-guide.rust-lang.org/
21+
22+
We have put significant work into finding and updating links around the
23+
`rust-lang/*` repos. We have also put up a website in place of the former
24+
`rustc-guide` website that redirects to the new one.
25+
26+
To update your git clone of the (former) `rustc-guide` repo, you can do the following:
27+
28+
```
29+
git remote set-url origin https://github.com/rust-lang/rustc-dev-guide.git
30+
```
31+
32+
This will change where git thinks the `origin` remote repo is to
33+
`rust-lang/rustc-dev-guide`.
34+
35+
You can find more information in [this issue][gh]. If you have any questions or
36+
concerns, please feel free to contact us either by opening an [issue on the
37+
rustc-dev-guide repo][repo] or on our [zulip channel][zulip].
38+
39+
[gh]: https://github.com/rust-lang/rustc-dev-guide/issues/602
40+
[repo]: https://github.com/rust-lang/rustc-dev-guide
41+
[zulip]: https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning

0 commit comments

Comments
 (0)