Skip to content

Rename rustc-guide -> rustc-dev-guide #537

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.

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 7 commits into from
Mar 13, 2020
Merged
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions posts/inside-rust/2020-03-13-rename-rustc-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
layout: post
title: "The rustc-guide is now rustc-dev-guide"
author: mark-i-m
description: "the guide has been renamed"
team: the rustc learning working group <https://www.rust-lang.org/governance/teams/compiler#wg-learning>
---

You may or may not be aware of two similarly named resources:
- [The rustc book](https://doc.rust-lang.org/rustc/index.html)
- [The rustc-guide](https://rustc-dev-guide.rust-lang.org/)

What's the difference? The "rustc book" is intended as a guide for _users_ of the
compiler. The "rustc-guide" is intended as a guide for _developers_ of the
compiler. However, the names have always been confusingly similar.

**For that reason, we have decided to rename the `rustc-guide` to
`rustc-dev-guide`. You can now find it at [https://rustc-dev-guide.rust-lang.org/][guide].**

[guide]: https://rustc-dev-guide.rust-lang.org/

We have put significant work into finding and updating links around the
`rust-lang/*` repos. We have also put up a website in place of the former
`rustc-guide` website that redirects to the new one.

To update your git clone of the (former) `rustc-guide` repo, you can do the following:

```
git remote set-url origin https://github.com/rust-lang/rustc-dev-guide.git
```

This will change where git thinks the `origin` remote repo is to
`rust-lang/rustc-dev-guide`.

You can find more information in [this issue][gh]. If you have any questions or
concerns, please feel free to contact us either by opening an [issue on the
rustc-dev-guide repo][repo] or on our [zulip channel][zulip].

[gh]: https://github.com/rust-lang/rustc-dev-guide/issues/602
[repo]: https://github.com/rust-lang/rustc-dev-guide
[zulip]: https://rust-lang.zulipchat.com/#narrow/stream/196385-t-compiler.2Fwg-learning