add a few more TOC sections

This commit is contained in:
Joshua Nelson 2023-03-25 20:11:38 -05:00 committed by jyn
parent 945da7bd13
commit 1fd8ddbdc2
7 changed files with 16 additions and 4 deletions

View File

@ -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 generated with crates that ceased to compile with or began to compile with your
changes. Crater runs can take a few days to complete. 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 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 to at least notify the authors of affected crates the breaking change. If we can

View File

@ -1,5 +1,7 @@
# How to build and run the compiler # How to build and run the compiler
<!-- toc -->
The compiler is built using a tool called `x.py`. You will need to The compiler is built using a tool called `x.py`. You will need to
have Python installed to run it. have Python installed to run it.

View File

@ -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 numerous end states and paths to get there, so not all sections may be
relevant to your desired goal. relevant to your desired goal.
<!-- toc -->
## Specifying a new LLVM ## Specifying a new LLVM
For very new targets, you may need to use a different fork of LLVM For very new targets, you may need to use a different fork of LLVM

View File

@ -3,6 +3,8 @@
The full bootstrapping process takes quite a while. Here are some suggestions The full bootstrapping process takes quite a while. Here are some suggestions
to make your life easier. to make your life easier.
<!-- toc -->
## Installing a pre-push hook ## Installing a pre-push hook
CI will automatically fail your build if it doesn't pass `tidy`, our CI will automatically fail your build if it doesn't pass `tidy`, our

View File

@ -1,5 +1,7 @@
# Contribution Procedures # Contribution Procedures
<!-- toc -->
## Bug Reports ## Bug Reports
While bugs are unfortunate, they're a reality in software. We can't fix what we While bugs are unfortunate, they're a reality in software. We can't fix what we

View File

@ -1,5 +1,7 @@
# Implementing new features # Implementing new features
<!-- toc -->
When you want to implement a new significant feature in the compiler, When you want to implement a new significant feature in the compiler,
you need to go through this process to make sure everything goes you need to go through this process to make sure everything goes
smoothly. smoothly.

View File

@ -1,8 +1,5 @@
# Rustdoc overview # 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 `rustdoc` lives in-tree with the
compiler and standard library. This chapter is about how it works. compiler and standard library. This chapter is about how it works.
For information about Rustdoc's features and how to use them, see 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
[Rustdoc internals]: ./rustdoc-internals.md [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 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 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] crate (HIR) and the ability to run some queries about the types of items. [HIR]