Skip to content

Commit fca8af6

Browse files
committed
add a few more TOC sections
1 parent 3cd6d38 commit fca8af6

7 files changed

+16
-4
lines changed

src/bug-fix-procedure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ public github repos with the compiler with your changes. A report will then be
174174
generated with crates that ceased to compile with or began to compile with your
175175
changes. Crater runs can take a few days to complete.
176176

177-
[Crater]: https://github.com/rust-lang/crater
177+
[Crater]: ./tests/crater.md
178178

179179
We should always do a crater run to assess impact. It is polite and considerate
180180
to at least notify the authors of affected crates the breaking change. If we can

src/building/how-to-build-and-run.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# How to build and run the compiler
22

3+
<!-- toc -->
4+
35
The compiler is built using a tool called `x.py`. You will need to
46
have Python installed to run it.
57

src/building/new-target.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ These are a set of steps to add support for a new target. There are
44
numerous end states and paths to get there, so not all sections may be
55
relevant to your desired goal.
66

7+
<!-- toc -->
8+
79
## Specifying a new LLVM
810

911
For very new targets, you may need to use a different fork of LLVM

src/building/suggested.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
The full bootstrapping process takes quite a while. Here are some suggestions
44
to make your life easier.
55

6+
<!-- toc -->
7+
68
## Installing a pre-push hook
79

810
CI will automatically fail your build if it doesn't pass `tidy`, our

src/contributing.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Contribution Procedures
22

3+
<!-- toc -->
4+
35
## Bug Reports
46

57
While bugs are unfortunate, they're a reality in software. We can't fix what we

src/implementing_new_features.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Implementing new features
22

3+
<!-- toc -->
4+
35
When you want to implement a new significant feature in the compiler,
46
you need to go through this process to make sure everything goes
57
smoothly.

src/rustdoc.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# Rustdoc overview
22

3-
`rustdoc` uses `rustc` internals (and, of course, the standard library), so you
4-
will have to build the compiler and `std` once before you can build `rustdoc`.
5-
63
`rustdoc` lives in-tree with the
74
compiler and standard library. This chapter is about how it works.
85
For information about Rustdoc's features and how to use them, see
@@ -12,6 +9,11 @@ For more details about how rustdoc works, see the
129

1310
[Rustdoc internals]: ./rustdoc-internals.md
1411

12+
<!-- toc -->
13+
14+
`rustdoc` uses `rustc` internals (and, of course, the standard library), so you
15+
will have to build the compiler and `std` once before you can build `rustdoc`.
16+
1517
Rustdoc is implemented entirely within the crate [`librustdoc`][rd]. It runs
1618
the compiler up to the point where we have an internal representation of a
1719
crate (HIR) and the ability to run some queries about the types of items. [HIR]

0 commit comments

Comments
 (0)