Skip to content

Commit 66be765

Browse files
authored
Rename rustc-guide to rustc-dev-guide (#601)
* Rename rustc-guide to rustc-dev-guide * rust-lang.github.io/rustc-dev-guide -> rustc-dev-guide.rust-lang.org
1 parent cb00f31 commit 66be765

11 files changed

+29
-29
lines changed

README.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
![Travis CI badge](https://api.travis-ci.com/rust-lang/rustc-guide.svg?branch=master)
1+
![Travis CI badge](https://api.travis-ci.com/rust-lang/rustc-dev-guide.svg?branch=master)
22

33

44
This is a collaborative effort to build a guide that explains how rustc
55
works. The aim of the guide is to help new contributors get oriented
66
to rustc, as well as to help more experienced folks in figuring out
77
some new part of the compiler that they haven't worked on before.
88

9-
[You can read the latest version of the guide here.](https://rust-lang.github.io/rustc-guide/)
9+
[You can read the latest version of the guide here.](https://rustc-dev-guide.rust-lang.org/)
1010

1111
You may also find the rustdocs [for the compiler itself][rustdocs] useful.
1212

@@ -18,7 +18,7 @@ The guide is useful today, but it has a lot of work still go.
1818

1919
If you'd like to help improve the guide, we'd love to have you! You can find
2020
plenty of issues on the [issue
21-
tracker](https://github.com/rust-lang/rustc-guide/issues). Just post a
21+
tracker](https://github.com/rust-lang/rustc-dev-guide/issues). Just post a
2222
comment on the issue you would like to work on to make sure that we don't
2323
accidentally duplicate work. If you think something is missing, please open an
2424
issue about it!
@@ -55,28 +55,28 @@ You will need `mdbook` version `>= 0.3.5` and `mdbook-linkcheck` version `>= 0.5
5555

5656
4. Follow the check-azure link to get to the Azure website for that build: https://dev.azure.com/rust-lang/e71b0ddf-dd27-435a-873c-e30f86eea377/_build/results?buildId=7780
5757

58-
5. There will be approximately 1 billion different jobs for the build. They are for different configurations and platforms. The rustc-guide build only runs on the Linux x86_64-gnu-tools job. So click on that job in the list, which is about 60% down in the list.
58+
5. There will be approximately 1 billion different jobs for the build. They are for different configurations and platforms. The rustc-dev-guide build only runs on the Linux x86_64-gnu-tools job. So click on that job in the list, which is about 60% down in the list.
5959

6060
6. Click the Run build step in the job to get the console log for the step.
6161

6262
7. Click on the log and Ctrl-f to get a search box in the log
6363

64-
8. Search for rustc-guide. This gets you to the place where the links are checked. It is usually ~11K lines into the log
64+
8. Search for rustc-dev-guide. This gets you to the place where the links are checked. It is usually ~11K lines into the log
6565

6666
9. Look at the links in the log near that point in the log
6767

68-
10. Fix those links in the rustc-guide (by making a PR in the rustc-guide repo)
68+
10. Fix those links in the rustc-dev-guide (by making a PR in the rustc-dev-guide repo)
6969

70-
11. Make a PR on the rust-lang/rust repo to update the rustc-guide git submodule in src/docs/rustc-guide.
70+
11. Make a PR on the rust-lang/rust repo to update the rustc-dev-guide git submodule in src/docs/rustc-dev-guide.
7171
To make a PR, the following steps are useful.
7272

7373
```bash
7474
# Assuming you already cloned the rust-lang/rust repo and you're in the correct directory
75-
git submodule update --remote src/doc/rustc-guide
75+
git submodule update --remote src/doc/rustc-dev-guide
7676
git add -u
77-
git commit -m "Update rustc-guide"
77+
git commit -m "Update rustc-dev-guide"
7878
# Note that you can use -i, which is short for --incremental, in the following command
79-
./x.py test --incremental --stage 1 src/doc/rustc-guide # This is optional and should succeed anyway
79+
./x.py test --incremental --stage 1 src/doc/rustc-dev-guide # This is optional and should succeed anyway
8080
# Open a PR in rust-lang/rust
8181
```
8282

book.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description = "A guide to developing rustc"
77
create-missing = false
88

99
[output.html]
10-
git-repository-url = "https://github.com/rust-lang/rustc-guide"
10+
git-repository-url = "https://github.com/rust-lang/rustc-dev-guide"
1111

1212
[output.html.fold]
1313
enable = true

src/about-this-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You might also find the following sites useful:
2525
- [compiler-team] -- the home-base for the rust compiler team, with description
2626
of the team procedures, active working groups, and the team calendar.
2727

28-
[GitHub repository]: https://github.com/rust-lang/rustc-guide/
28+
[GitHub repository]: https://github.com/rust-lang/rustc-dev-guide/
2929
[Rustc API docs]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc/
3030
[Forge]: https://forge.rust-lang.org/
3131
[compiler-team]: https://github.com/rust-lang/compiler-team/

src/debugging-support-in-rustc.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,13 @@ the trait object.
7777
**TODO**: Figure out if the following should be mentioned in the GDB-Rust document rather than
7878
this guide page so there is no duplication. This is regarding the following comments:
7979

80-
[This comment by Tom](https://github.com/rust-lang/rustc-guide/pull/316#discussion_r284027340)
80+
[This comment by Tom](https://github.com/rust-lang/rustc-dev-guide/pull/316#discussion_r284027340)
8181
> gdb's Rust extensions and limitations are documented in the gdb manual:
8282
https://sourceware.org/gdb/onlinedocs/gdb/Rust.html -- however, this neglects to mention that
8383
gdb convenience variables and registers follow the gdb $ convention, and that the Rust parser
8484
implements the gdb @ extension.
8585

86-
[This question by Aman](https://github.com/rust-lang/rustc-guide/pull/316#discussion_r285401353)
86+
[This question by Aman](https://github.com/rust-lang/rustc-dev-guide/pull/316#discussion_r285401353)
8787
> @tromey do you think we should mention this part in the GDB-Rust document rather than this
8888
document so there is no duplication etc.?
8989

@@ -276,7 +276,7 @@ set the breakpoints and what happens when you step it.
276276
* New demangler in LLVM or LLDB.
277277

278278
**TODO**: Check the location of the demangler source.
279-
[Question on Github](https://github.com/rust-lang/rustc-guide/pull/316#discussion_r283062536).
279+
[Question on Github](https://github.com/rust-lang/rustc-dev-guide/pull/316#discussion_r283062536).
280280

281281
#### Reuse Rust compiler for expressions
282282

src/ice-breaker/llvm.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ the result of an LLVM upgrade. The goal here is:
1616
## Helpful tips and options
1717

1818
The ["Debugging LLVM"][d] section of the
19-
rustc-guide gives a step-by-step process for how to help debug bugs
19+
rustc-dev-guide gives a step-by-step process for how to help debug bugs
2020
caused by LLVM. In particular, it discusses how to emit LLVM IR, run
2121
the LLVM IR optimization pipeliness, and so forth. You may also find
2222
it useful to look at the various codegen options listed under `-Chelp`

src/implementing_new_features.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ for stabilization in a checklist, e.g.,
106106
107107
- [ ] Implement the RFC. (CC @rust-lang/compiler -- can anyone write
108108
up mentoring instructions?)
109-
- [ ] Adjust the documentation. ([See instructions on rustc-guide.](https://rust-lang.github.io/rustc-guide/stabilization_guide.html#documentation-prs))
110-
- [ ] Stabilize the feature. ([See instructions on rustc-guide.](https://rust-lang.github.io/rustc-guide/stabilization_guide.html#stabilization-pr))
109+
- [ ] Adjust the documentation. ([See instructions on rustc-dev-guide.](https://rustc-dev-guide.rust-lang.org/stabilization_guide.html#documentation-prs))
110+
- [ ] Stabilize the feature. ([See instructions on rustc-dev-guide.](https://rustc-dev-guide.rust-lang.org/stabilization_guide.html#stabilization-pr))
111111
```
112112

113113
<a name="stability-in-code"></a>

src/macro-expansion.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ just have a zulip discussion where you tell us (WG-learning) everything you
227227
know about macros/expansion/hygiene. We were thinking this could be less formal
228228
(and less work for you) than compiler lecture series lecture... thoughts?
229229
230-
mark-i-m: The goal is to fill out that long-standing gap in the rustc-guide
230+
mark-i-m: The goal is to fill out that long-standing gap in the rustc-dev-guide
231231
232232
Vadim Petrochenkov: Ok, I'm at UTC+03:00 and generally available in the
233233
evenings (or weekends).
@@ -628,7 +628,7 @@ Vadim Petrochenkov: A thread for offline questions-answers would be good too.
628628
A thread for offline questions-answers would be good too.
629629
630630
I don't mind using this thread, since it already has a lot of info in it. We
631-
also plan to summarize the info from this thread into the rustc-guide.
631+
also plan to summarize the info from this thread into the rustc-dev-guide.
632632
633633
Sure, why not.
634634
@@ -648,7 +648,7 @@ eager expansion...
648648
Santiago Pastorino: sorry but I couldn't follow that much today, will read it
649649
when I have some time later
650650
651-
Santiago Pastorino: btw https://github.com/rust-lang/rustc-guide/issues/398
651+
Santiago Pastorino: btw https://github.com/rust-lang/rustc-dev-guide/issues/398
652652
653653
mark-i-m: @Vadim Petrochenkov Would 7pm UTC on August 21 work for a followup?
654654

src/mir/optimizations.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ to do, so compilation is faster. Note that since MIR is generic (not
88
effective; we can optimize the generic version, so all of the monomorphizations
99
are cheaper!
1010

11-
[mir]: https://rust-lang.github.io/rustc-guide/mir/index.html
12-
[monomorph]: https://rust-lang.github.io/rustc-guide/appendix/glossary.html?highlight=monomorphize#appendix-c-glossary
11+
[mir]: https://rustc-dev-guide.rust-lang.org/mir/index.html
12+
[monomorph]: https://rustc-dev-guide.rust-lang.org/appendix/glossary.html?highlight=monomorphize#appendix-c-glossary
1313

1414
MIR optimizations run after borrow checking. We run a series of optimization
1515
passes over the MIR to improve it. Some passes are required to run on all code,
@@ -22,9 +22,9 @@ run and that some validation has occurred. Then, it [steals][steal] the MIR
2222
optimizes it, and returns the improved MIR.
2323

2424
[optmir]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_mir/transform/fn.optimized_mir.html
25-
[query]: https://rust-lang.github.io/rustc-guide/query.html
26-
[defid]: https://rust-lang.github.io/rustc-guide/appendix/glossary.html?highlight=DefId#appendix-c-glossary
27-
[steal]: https://rust-lang.github.io/rustc-guide/mir/passes.html?highlight=steal#stealing
25+
[query]: https://rustc-dev-guide.rust-lang.org/query.html
26+
[defid]: https://rustc-dev-guide.rust-lang.org/appendix/glossary.html?highlight=DefId#appendix-c-glossary
27+
[steal]: https://rustc-dev-guide.rust-lang.org/mir/passes.html?highlight=steal#stealing
2828

2929
## Defining optimization passes
3030

src/part-1-intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Part 1: Building, debugging, and contributing to Rustc
22

3-
This section of the rustc-guide contains knowledge that should be useful to you
3+
This section of the rustc-dev-guide contains knowledge that should be useful to you
44
regardless of what part of the compiler you are working on. This includes both
55
technical info and tips (e.g. how to compile and debug the compiler) and info
66
about processes in the Rust project (e.g. stabilization and info about the

src/part-2-intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ compilation works.
77
This section should be friendly to both readers interested in the end-to-end
88
process of compilation _and_ readers interested in learning about a specific
99
system they wish to contribute to. If anything is unclear, feel free to file
10-
an issue on the [rustc-guide repo](https://github.com/rust-lang/rustc-guide)
10+
an issue on the [rustc-dev-guide repo](https://github.com/rust-lang/rustc-dev-guide)
1111
or contact the compiler team, as detailed in [this chapter from Part
1212
1](./compiler-team.md).

src/traits/chalk-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ Likewise, lowering tests use the [`lowering_success!` and
226226

227227
[ast]: https://en.wikipedia.org/wiki/Abstract_syntax_tree
228228
[chalk]: https://github.com/rust-lang/chalk
229-
[rustc-issues]: https://github.com/rust-lang/rustc-guide/issues
229+
[rustc-issues]: https://github.com/rust-lang/rustc-dev-guide/issues
230230
[universal quantification]: https://en.wikipedia.org/wiki/Universal_quantification
231231

232232
[`ProgramClause`]: https://rust-lang.github.io/chalk/chalk_ir/enum.ProgramClause.html

0 commit comments

Comments
 (0)