From fca8af6c154c6cde2512f1331cf2704f214a818e Mon Sep 17 00:00:00 2001 From: Joshua Nelson Date: Sat, 25 Mar 2023 20:11:38 -0500 Subject: [PATCH] add a few more TOC sections --- src/bug-fix-procedure.md | 2 +- src/building/how-to-build-and-run.md | 2 ++ src/building/new-target.md | 2 ++ src/building/suggested.md | 2 ++ src/contributing.md | 2 ++ src/implementing_new_features.md | 2 ++ src/rustdoc.md | 8 +++++--- 7 files changed, 16 insertions(+), 4 deletions(-) diff --git a/src/bug-fix-procedure.md b/src/bug-fix-procedure.md index 65881c24012d..e69ce48f9537 100644 --- a/src/bug-fix-procedure.md +++ b/src/bug-fix-procedure.md @@ -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 diff --git a/src/building/how-to-build-and-run.md b/src/building/how-to-build-and-run.md index 564136453a06..ffb93f6b2891 100644 --- a/src/building/how-to-build-and-run.md +++ b/src/building/how-to-build-and-run.md @@ -1,5 +1,7 @@ # How to build and run the compiler + + The compiler is built using a tool called `x.py`. You will need to have Python installed to run it. diff --git a/src/building/new-target.md b/src/building/new-target.md index f999a94721f1..629445be6a26 100644 --- a/src/building/new-target.md +++ b/src/building/new-target.md @@ -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. + + ## Specifying a new LLVM For very new targets, you may need to use a different fork of LLVM diff --git a/src/building/suggested.md b/src/building/suggested.md index c7aab9a48af0..3049d87db4e3 100644 --- a/src/building/suggested.md +++ b/src/building/suggested.md @@ -3,6 +3,8 @@ The full bootstrapping process takes quite a while. Here are some suggestions to make your life easier. + + ## Installing a pre-push hook CI will automatically fail your build if it doesn't pass `tidy`, our diff --git a/src/contributing.md b/src/contributing.md index 0b4fa5c56e76..549c18cc4951 100644 --- a/src/contributing.md +++ b/src/contributing.md @@ -1,5 +1,7 @@ # Contribution Procedures + + ## Bug Reports While bugs are unfortunate, they're a reality in software. We can't fix what we diff --git a/src/implementing_new_features.md b/src/implementing_new_features.md index 9bd853080d11..946637d29d49 100644 --- a/src/implementing_new_features.md +++ b/src/implementing_new_features.md @@ -1,5 +1,7 @@ # Implementing new features + + 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. diff --git a/src/rustdoc.md b/src/rustdoc.md index d58b27bb71b9..cbe5e8b1f92d 100644 --- a/src/rustdoc.md +++ b/src/rustdoc.md @@ -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 @@ -12,6 +9,11 @@ For more details about how rustdoc works, see the [Rustdoc internals]: ./rustdoc-internals.md + + +`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]