Skip to content

Commit

Permalink
add a few more TOC sections
Browse files Browse the repository at this point in the history
  • Loading branch information
jyn514 committed Apr 3, 2023
1 parent 3cd6d38 commit fca8af6
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/bug-fix-procedure.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ public github repos with the compiler with your changes. A report will then be
generated with crates that ceased to compile with or began to compile with your
changes. Crater runs can take a few days to complete.

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

We should always do a crater run to assess impact. It is polite and considerate
to at least notify the authors of affected crates the breaking change. If we can
Expand Down
2 changes: 2 additions & 0 deletions src/building/how-to-build-and-run.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# How to build and run the compiler

<!-- toc -->

The compiler is built using a tool called `x.py`. You will need to
have Python installed to run it.

Expand Down
2 changes: 2 additions & 0 deletions src/building/new-target.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ These are a set of steps to add support for a new target. There are
numerous end states and paths to get there, so not all sections may be
relevant to your desired goal.

<!-- toc -->

## Specifying a new LLVM

For very new targets, you may need to use a different fork of LLVM
Expand Down
2 changes: 2 additions & 0 deletions src/building/suggested.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
The full bootstrapping process takes quite a while. Here are some suggestions
to make your life easier.

<!-- toc -->

## Installing a pre-push hook

CI will automatically fail your build if it doesn't pass `tidy`, our
Expand Down
2 changes: 2 additions & 0 deletions src/contributing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Contribution Procedures

<!-- toc -->

## Bug Reports

While bugs are unfortunate, they're a reality in software. We can't fix what we
Expand Down
2 changes: 2 additions & 0 deletions src/implementing_new_features.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Implementing new features

<!-- toc -->

When you want to implement a new significant feature in the compiler,
you need to go through this process to make sure everything goes
smoothly.
Expand Down
8 changes: 5 additions & 3 deletions src/rustdoc.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
# Rustdoc overview

`rustdoc` uses `rustc` internals (and, of course, the standard library), so you
will have to build the compiler and `std` once before you can build `rustdoc`.

`rustdoc` lives in-tree with the
compiler and standard library. This chapter is about how it works.
For information about Rustdoc's features and how to use them, see
Expand All @@ -12,6 +9,11 @@ For more details about how rustdoc works, see the

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

<!-- toc -->

`rustdoc` uses `rustc` internals (and, of course, the standard library), so you
will have to build the compiler and `std` once before you can build `rustdoc`.

Rustdoc is implemented entirely within the crate [`librustdoc`][rd]. It runs
the compiler up to the point where we have an internal representation of a
crate (HIR) and the ability to run some queries about the types of items. [HIR]
Expand Down

0 comments on commit fca8af6

Please sign in to comment.