Skip to content

Commit 4a71db1

Browse files
committed
use consistent title capitalization
1 parent a4f63f3 commit 4a71db1

19 files changed

+44
-45
lines changed

Diff for: src/SUMMARY.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
- [How to build and run the compiler](./building/how-to-build-and-run.md)
1111
- [Quickstart](./building/quickstart.md)
1212
- [Prerequisites](./building/prerequisites.md)
13-
- [Suggested Workflows](./building/suggested.md)
13+
- [Suggested workflows](./building/suggested.md)
1414
- [Distribution artifacts](./building/build-install-distribution-artifacts.md)
15-
- [Building Documentation](./building/compiler-documenting.md)
15+
- [Building documentation](./building/compiler-documenting.md)
1616
- [Rustdoc overview](./rustdoc.md)
1717
- [Adding a new target](./building/new-target.md)
1818
- [Optimized build](./building/optimized-build.md)
@@ -42,11 +42,11 @@
4242
- [with the linux perf tool](./profiling/with_perf.md)
4343
- [with Windows Performance Analyzer](./profiling/wpa_profiling.md)
4444
- [with the Rust benchmark suite](./profiling/with_rustc_perf.md)
45-
- [crates.io Dependencies](./crates-io.md)
45+
- [crates.io dependencies](./crates-io.md)
4646

4747
# Contributing to Rust
4848

49-
- [Contribution Procedures](./contributing.md)
49+
- [Contribution procedures](./contributing.md)
5050
- [About the compiler team](./compiler-team.md)
5151
- [Using Git](./git.md)
5252
- [Mastering @rustbot](./rustbot.md)
@@ -56,7 +56,7 @@
5656
- [Stabilizing Features](./stabilization_guide.md)
5757
- [Feature Gates](./feature-gates.md)
5858
- [Coding conventions](./conventions.md)
59-
- [Procedures for Breaking Changes](./bug-fix-procedure.md)
59+
- [Procedures for breaking changes](./bug-fix-procedure.md)
6060
- [Using external repositories](./external-repos.md)
6161
- [Fuzzing](./fuzzing.md)
6262
- [Notification groups](notification-groups/about.md)
@@ -88,29 +88,29 @@
8888
- [Overview of the compiler](./overview.md)
8989
- [The compiler source code](./compiler-src.md)
9090
- [Queries: demand-driven compilation](./query.md)
91-
- [The Query Evaluation Model in Detail](./queries/query-evaluation-model-in-detail.md)
91+
- [The Query Evaluation Model in detail](./queries/query-evaluation-model-in-detail.md)
9292
- [Incremental compilation](./queries/incremental-compilation.md)
93-
- [Incremental compilation In Detail](./queries/incremental-compilation-in-detail.md)
94-
- [Debugging and Testing](./incrcomp-debugging.md)
93+
- [Incremental compilation in detail](./queries/incremental-compilation-in-detail.md)
94+
- [Debugging and testing](./incrcomp-debugging.md)
9595
- [Salsa](./queries/salsa.md)
96-
- [Memory Management in Rustc](./memory.md)
97-
- [Serialization in Rustc](./serialization.md)
98-
- [Parallel Compilation](./parallel-rustc.md)
96+
- [Memory management in rustc](./memory.md)
97+
- [Serialization in rustc](./serialization.md)
98+
- [Parallel compilation](./parallel-rustc.md)
9999
- [Rustdoc internals](./rustdoc-internals.md)
100100
- [Search](./rustdoc-internals/search.md)
101101
- [The `rustdoc` test suite](./rustdoc-internals/rustdoc-test-suite.md)
102102
# Source Code Representation
103103

104104
- [Prologue](./part-3-intro.md)
105105
- [Syntax and the AST](./syntax-intro.md)
106-
- [Lexing and Parsing](./the-parser.md)
106+
- [Lexing and parsing](./the-parser.md)
107107
- [Macro expansion](./macro-expansion.md)
108108
- [Name resolution](./name-resolution.md)
109109
- [Attributes](./attributes.md)
110-
- [`#[test]` Implementation](./test-implementation.md)
111-
- [Panic Implementation](./panic-implementation.md)
112-
- [AST Validation](./ast-validation.md)
113-
- [Feature Gate Checking](./feature-gate-ck.md)
110+
- [`#[test]` implementation](./test-implementation.md)
111+
- [Panic implementation](./panic-implementation.md)
112+
- [AST validation](./ast-validation.md)
113+
- [Feature gate checking](./feature-gate-ck.md)
114114
- [Lang Items](./lang-items.md)
115115
- [The HIR (High-level IR)](./hir.md)
116116
- [Lowering AST to HIR](./ast-lowering.md)
@@ -129,7 +129,7 @@
129129
- [Example: Type checking](./rustc-driver/interacting-with-the-ast.md)
130130
- [Example: Getting diagnostics](./rustc-driver/getting-diagnostics.md)
131131
- [Remarks on perma-unstable features](./rustc-driver/remarks-on-perma-unstable-features.md)
132-
- [Errors and Lints](diagnostics.md)
132+
- [Errors and lints](diagnostics.md)
133133
- [Diagnostic and subdiagnostic structs](./diagnostics/diagnostic-structs.md)
134134
- [Translation](./diagnostics/translation.md)
135135
- [`LintStore`](./diagnostics/lintstore.md)
@@ -175,14 +175,14 @@
175175
- [Type checking](./type-checking.md)
176176
- [Method Lookup](./method-lookup.md)
177177
- [Variance](./variance.md)
178-
- [Coherence Checking](./coherence.md)
179-
- [Opaque Types](./opaque-types-type-alias-impl-trait.md)
178+
- [Coherence checking](./coherence.md)
179+
- [Opaque types](./opaque-types-type-alias-impl-trait.md)
180180
- [Inference details](./opaque-types-impl-trait-inference.md)
181181
- [Return Position Impl Trait In Trait](./return-position-impl-trait-in-trait.md)
182182
- [Region inference restrictions][opaque-infer]
183183
- [Const condition checking](./effects.md)
184184
- [Pattern and Exhaustiveness Checking](./pat-exhaustive-checking.md)
185-
- [Unsafety Checking](./unsafety-checking.md)
185+
- [Unsafety checking](./unsafety-checking.md)
186186
- [MIR dataflow](./mir/dataflow.md)
187187
- [Drop elaboration](./mir/drop-elaboration.md)
188188
- [The borrow checker](./borrow_check.md)

Diff for: src/ast-validation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AST Validation
1+
# AST validation
22

33
_AST validation_ is a separate AST pass that visits each
44
item in the tree and performs simple checks. This pass

Diff for: src/bug-fix-procedure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Procedures for Breaking Changes
1+
# Procedures for breaking changes
22

33
<!-- toc -->
44

Diff for: src/building/suggested.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Suggested Workflows
1+
# Suggested workflows
22

33
The full bootstrapping process takes quite a while. Here are some suggestions to
44
make your life easier.

Diff for: src/coherence.md

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# Coherence
32

43
> NOTE: this is based on [notes by @lcnr](https://github.com/rust-lang/rust/pull/121848)

Diff for: src/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contribution Procedures
1+
# Contribution procedures
22

33
<!-- toc -->
44

Diff for: src/crates-io.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# crates.io Dependencies
1+
# crates.io dependencies
22

33
The Rust compiler supports building with some dependencies from `crates.io`.
44
Examples are `log` and `env_logger`.

Diff for: src/diagnostics.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Errors and Lints
1+
# Errors and lints
22

33
<!-- toc -->
44

@@ -772,7 +772,7 @@ store.register_renamed("single_use_lifetime", "single_use_lifetimes");
772772
[`store.register_removed`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/struct.LintStore.html#method.register_removed
773773
[`rustc_lint::register_builtins`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_lint/fn.register_builtins.html
774774

775-
### Lint Groups
775+
### Lint groups
776776

777777
Lints can be turned on in groups. These groups are declared in the
778778
[`register_builtins`][rbuiltins] function in [`rustc_lint::lib`][builtin]. The

Diff for: src/feature-gates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Feature Gates
1+
# Feature gates
22

33
This chapter is intended to provide basic help for adding, removing, and
44
modifying feature gates.

Diff for: src/incrcomp-debugging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Debugging and Testing Dependencies
1+
# Debugging and testing dependencies
22

33
## Testing the dependency graph
44

Diff for: src/memory.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Memory Management in Rustc
1+
# Memory management in rustc
22

33
Generally rustc tries to be pretty careful how it manages memory.
44
The compiler allocates _a lot_ of data structures throughout compilation,

Diff for: src/panic-implementation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Panicking in rust
1+
# Panicking in Rust
22

33
<!-- toc -->
44

Diff for: src/parallel-rustc.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Parallel Compilation
1+
# Parallel compilation
22

33
<div class="warning">
44
As of <!-- date-check --> November 2024,
@@ -28,7 +28,7 @@ The following sections are kept for now but are quite outdated.
2828

2929
[codegen]: backend/codegen.md
3030

31-
## Code Generation
31+
## Code generation
3232

3333
During monomorphization the compiler splits up all the code to
3434
be generated into smaller chunks called _codegen units_. These are then generated by
@@ -38,7 +38,7 @@ occurs in the [`rustc_codegen_ssa::base`] module.
3838

3939
[`rustc_codegen_ssa::base`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_codegen_ssa/base/index.html
4040

41-
## Data Structures
41+
## Data structures
4242

4343
The underlying thread-safe data-structures used in the parallel compiler
4444
can be found in the [`rustc_data_structures::sync`] module. These data structures
@@ -83,7 +83,7 @@ can be accessed directly through `Deref::deref`.
8383
[`rustc_data_structures::sync::worker_local`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_data_structures/sync/worker_local/index.html
8484
[`WorkerLocal`]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_data_structures/sync/worker_local/struct.WorkerLocal.html
8585

86-
## Parallel Iterator
86+
## Parallel iterator
8787

8888
The parallel iterators provided by the [`rayon`] crate are easy ways to
8989
implement parallelism. In the current implementation of the parallel compiler
@@ -124,7 +124,7 @@ the parallel iterator function has been used are as follows:
124124

125125
There are still many loops that have the potential to use parallel iterators.
126126

127-
## Query System
127+
## Query system
128128

129129
The query model has some properties that make it actually feasible to evaluate
130130
multiple queries in parallel without too much effort:

Diff for: src/queries/incremental-compilation-in-detail.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Incremental Compilation In Detail
1+
# Incremental Compilation in detail
22

33
<!-- toc -->
44

Diff for: src/queries/query-evaluation-model-in-detail.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# The Query Evaluation Model in Detail
1+
# The Query Evaluation Model in detail
22

33
<!-- toc -->
44

Diff for: src/serialization.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Serialization in Rustc
1+
# Serialization in rustc
22

33
rustc has to [serialize] and deserialize various data during compilation.
44
Specifically:

Diff for: src/test-implementation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ with your hand-written one, it will not share a [Symbol][Symbol]. This
8383
technique prevents name collision during code generation and is the foundation
8484
of Rust's [`macro`] hygiene.
8585

86-
## Step 2: Harness Generation
86+
## Step 2: Harness generation
8787

8888
Now that our tests are accessible from the root of our crate, we need to do
8989
something with them using [`rustc_ast`][ast] generates a module like so:
@@ -106,7 +106,7 @@ called [`test`][test] that is part of Rust core, that implements all of the
106106
runtime for testing. [`test`][test]'s interface is unstable, so the only stable way
107107
to interact with it is through the `#[test]` macro.
108108

109-
## Step 3: Test Object Generation
109+
## Step 3: Test object generation
110110

111111
If you've written tests in Rust before, you may be familiar with some of the
112112
optional attributes available on test functions. For example, a test can be

Diff for: src/the-parser.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Lexing and Parsing
1+
# Lexing and parsing
22

33
The very first thing the compiler does is take the program (in UTF-8 Unicode text)
44
and turn it into a data format the compiler can work with more conveniently than strings.
@@ -59,7 +59,7 @@ Note that while parsing, we may encounter macro definitions or invocations.
5959
We set these aside to be expanded (see [Macro Expansion](./macro-expansion.md)).
6060
Expansion itself may require parsing the output of a macro, which may reveal more macros to be expanded, and so on.
6161

62-
## More on Lexical Analysis
62+
## More on lexical analysis
6363

6464
Code for lexical analysis is split between two crates:
6565

Diff for: src/unsafety-checking.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Unsafety Checking
1+
# Unsafety checking
22

33
Certain expressions in Rust can violate memory safety and as such need to be
44
inside an `unsafe` block or function. The compiler will also warn if an unsafe

0 commit comments

Comments
 (0)