Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lower-case "Compiler" in headings, for consistency (and looks) #1605

Merged
merged 2 commits into from
Feb 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

# Building and debugging `rustc`

- [How to Build and Run the Compiler](./building/how-to-build-and-run.md)
- [How to build and run the compiler](./building/how-to-build-and-run.md)
- [Prerequisites](./building/prerequisites.md)
- [Suggested Workflows](./building/suggested.md)
- [Distribution artifacts](./building/build-install-distribution-artifacts.md)
Expand All @@ -25,7 +25,7 @@
- [Test headers](./tests/headers.md)
- [Performance testing](./tests/perf.md)
- [Crater](./tests/crater.md)
- [Debugging the Compiler](./compiler-debugging.md)
- [Debugging the compiler](./compiler-debugging.md)
- [Using the tracing/logging instrumentation](./tracing.md)
- [Profiling the compiler](./profiling.md)
- [with the linux perf tool](./profiling/with_perf.md)
Expand Down Expand Up @@ -57,7 +57,7 @@
# High-level Compiler Architecture

- [Prologue](./part-2-intro.md)
- [Overview of the Compiler](./overview.md)
- [Overview of the compiler](./overview.md)
- [The compiler source code](./compiler-src.md)
- [Bootstrapping](./building/bootstrapping.md)
- [Queries: demand-driven compilation](./query.md)
Expand Down Expand Up @@ -95,7 +95,7 @@
- [MIR construction](./mir/construction.md)
- [MIR visitor and traversal](./mir/visitor.md)
- [MIR passes: getting the MIR for a function](./mir/passes.md)
- [Identifiers in the Compiler](./identifiers.md)
- [Identifiers in the compiler](./identifiers.md)
- [Closure expansion](./closure.md)
- [Inline assembly](./asm.md)

Expand Down Expand Up @@ -168,7 +168,7 @@
- [Profile-guided Optimization](./profile-guided-optimization.md)
- [LLVM Source-Based Code Coverage](./llvm-coverage-instrumentation.md)
- [Sanitizers Support](./sanitizers.md)
- [Debugging Support in the Rust Compiler](./debugging-support-in-rustc.md)
- [Debugging support in the Rust compiler](./debugging-support-in-rustc.md)

---

Expand Down
4 changes: 2 additions & 2 deletions src/building/bootstrapping.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Bootstrapping the Compiler
# Bootstrapping the compiler

<!-- toc -->

Expand Down Expand Up @@ -90,7 +90,7 @@ because one must first build the new compiler with an older compiler
and then use that to build the new compiler with itself.
For development, you usually only want the `stage1` compiler,
which you can build with `./x.py build library`.
See [Building the Compiler](./how-to-build-and-run.html#building-the-compiler).
See [Building the compiler](./how-to-build-and-run.html#building-the-compiler).
camelid marked this conversation as resolved.
Show resolved Hide resolved

### Stage 3

Expand Down
4 changes: 2 additions & 2 deletions src/building/how-to-build-and-run.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How to Build and Run the Compiler
# 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.
Expand Down Expand Up @@ -52,7 +52,7 @@ If you have already built `rustc` and you change settings related to LLVM, then
execute `rm -rf build` for subsequent configuration changes to take effect. Note that `./x.py
clean` will not cause a rebuild of LLVM.

## Building the Compiler
## Building the compiler

Note that building will require a relatively large amount of storage space.
You may want to have upwards of 10 or 15 gigabytes available to build the compiler.
Expand Down
2 changes: 1 addition & 1 deletion src/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ normally used for: building, testing, creating releases, formatting, etc.

[bootstrapping]: ./building/bootstrapping.md

### Configuring the Compiler
### Configuring the compiler

In the top level of the repo:

Expand Down
2 changes: 1 addition & 1 deletion src/identifiers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Identifiers in the Compiler
# Identifiers in the compiler

If you have read the few previous chapters, you now know that `rustc` uses
many different intermediate representations to perform different kinds of analyses.
Expand Down
2 changes: 1 addition & 1 deletion src/overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Overview of the Compiler
# Overview of the compiler

<!-- toc -->

Expand Down