Skip to content

Commit a6f2d67

Browse files
authored
Merge pull request #2441 from rust-lang/tshepang-remove-title-case
use consistent title capitalization
2 parents 6966390 + 1f2bdb5 commit a6f2d67

8 files changed

+28
-28
lines changed

src/SUMMARY.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -181,15 +181,15 @@
181181
- [Significant changes and quirks](./solve/significant-changes.md)
182182
- [`Unsize` and `CoerceUnsized` traits](./traits/unsize.md)
183183
- [Type checking](./type-checking.md)
184-
- [Method Lookup](./method-lookup.md)
184+
- [Method lookup](./method-lookup.md)
185185
- [Variance](./variance.md)
186186
- [Coherence checking](./coherence.md)
187187
- [Opaque types](./opaque-types-type-alias-impl-trait.md)
188188
- [Inference details](./opaque-types-impl-trait-inference.md)
189189
- [Return Position Impl Trait In Trait](./return-position-impl-trait-in-trait.md)
190190
- [Region inference restrictions][opaque-infer]
191191
- [Const condition checking](./effects.md)
192-
- [Pattern and Exhaustiveness Checking](./pat-exhaustive-checking.md)
192+
- [Pattern and exhaustiveness checking](./pat-exhaustive-checking.md)
193193
- [Unsafety checking](./unsafety-checking.md)
194194
- [MIR dataflow](./mir/dataflow.md)
195195
- [Drop elaboration](./mir/drop-elaboration.md)
@@ -209,7 +209,7 @@
209209
- [Closure capture inference](./closure.md)
210210
- [Async closures/"coroutine-closures"](coroutine-closures.md)
211211

212-
# MIR to Binaries
212+
# MIR to binaries
213213

214214
- [Prologue](./part-5-intro.md)
215215
- [MIR optimizations](./mir/optimizations.md)
@@ -218,15 +218,15 @@
218218
- [Interpreter](./const-eval/interpret.md)
219219
- [Monomorphization](./backend/monomorph.md)
220220
- [Lowering MIR](./backend/lowering-mir.md)
221-
- [Code Generation](./backend/codegen.md)
221+
- [Code generation](./backend/codegen.md)
222222
- [Updating LLVM](./backend/updating-llvm.md)
223223
- [Debugging LLVM](./backend/debugging.md)
224224
- [Backend Agnostic Codegen](./backend/backend-agnostic.md)
225-
- [Implicit Caller Location](./backend/implicit-caller-location.md)
226-
- [Libraries and Metadata](./backend/libs-and-metadata.md)
227-
- [Profile-guided Optimization](./profile-guided-optimization.md)
228-
- [LLVM Source-Based Code Coverage](./llvm-coverage-instrumentation.md)
229-
- [Sanitizers Support](./sanitizers.md)
225+
- [Implicit caller location](./backend/implicit-caller-location.md)
226+
- [Libraries and metadata](./backend/libs-and-metadata.md)
227+
- [Profile-guided optimization](./profile-guided-optimization.md)
228+
- [LLVM source-based code coverage](./llvm-coverage-instrumentation.md)
229+
- [Sanitizers support](./sanitizers.md)
230230
- [Debugging support in the Rust compiler](./debugging-support-in-rustc.md)
231231

232232
---

src/backend/implicit-caller-location.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Implicit Caller Location
1+
# Implicit caller location
22

33
<!-- toc -->
44

@@ -8,7 +8,7 @@ adds the [`#[track_caller]`][attr-reference] attribute for functions, the
88
[`caller_location`][intrinsic] intrinsic, and the stabilization-friendly
99
[`core::panic::Location::caller`][wrapper] wrapper.
1010

11-
## Motivating Example
11+
## Motivating example
1212

1313
Take this example program:
1414

@@ -39,7 +39,7 @@ These error messages are achieved through a combination of changes to `panic!` i
3939
of `core::panic::Location::caller` and a number of `#[track_caller]` annotations in the standard
4040
library which propagate caller information.
4141

42-
## Reading Caller Location
42+
## Reading caller location
4343

4444
Previously, `panic!` made use of the `file!()`, `line!()`, and `column!()` macros to construct a
4545
[`Location`] pointing to where the panic occurred. These macros couldn't be given an overridden
@@ -51,7 +51,7 @@ was expanded. This function is itself annotated with `#[track_caller]` and wraps
5151
[`caller_location`][intrinsic] compiler intrinsic implemented by rustc. This intrinsic is easiest
5252
explained in terms of how it works in a `const` context.
5353

54-
## Caller Location in `const`
54+
## Caller location in `const`
5555

5656
There are two main phases to returning the caller location in a const context: walking up the stack
5757
to find the right location and allocating a const value to return.
@@ -138,7 +138,7 @@ fn main() {
138138
}
139139
```
140140

141-
### Dynamic Dispatch
141+
### Dynamic dispatch
142142

143143
In codegen contexts we have to modify the callee ABI to pass this information down the stack, but
144144
the attribute expressly does *not* modify the type of the function. The ABI change must be
@@ -156,7 +156,7 @@ probably the best we can do without modifying fully-stabilized type signatures.
156156
> whether we'll be called in a const context (safe to ignore shim) or in a codegen context (unsafe
157157
> to ignore shim). Even if we did know, the results from const and codegen contexts must agree.
158158
159-
## The Attribute
159+
## The attribute
160160

161161
The `#[track_caller]` attribute is checked alongside other codegen attributes to ensure the
162162
function:

src/backend/libs-and-metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Libraries and Metadata
1+
# Libraries and metadata
22

33
When the compiler sees a reference to an external crate, it needs to load some
44
information about that crate. This chapter gives an overview of that process,

src/llvm-coverage-instrumentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# LLVM Source-Based Code Coverage
1+
# LLVM source-based code coverage
22

33
<!-- toc -->
44

src/part-5-intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# From MIR to Binaries
1+
# From MIR to binaries
22

33
All of the preceding chapters of this guide have one thing in common:
44
we never generated any executable machine code at all!

src/pat-exhaustive-checking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Pattern and Exhaustiveness Checking
1+
# Pattern and exhaustiveness checking
22

33
In Rust, pattern matching and bindings have a few very helpful properties. The
44
compiler will check that bindings are irrefutable when made and that match arms

src/profile-guided-optimization.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Profile Guided Optimization
1+
# Profile-guided optimization
22

33
<!-- toc -->
44

55
`rustc` supports doing profile-guided optimization (PGO).
66
This chapter describes what PGO is and how the support for it is
77
implemented in `rustc`.
88

9-
## What Is Profiled-Guided Optimization?
9+
## What is profiled-guided optimization?
1010

1111
The basic concept of PGO is to collect data about the typical execution of
1212
a program (e.g. which branches it is likely to take) and then use this data
@@ -52,7 +52,7 @@ instrumentation, via the experimental option
5252
[`-C instrument-coverage`](./llvm-coverage-instrumentation.md), but using these
5353
coverage results for PGO has not been attempted at this time.
5454

55-
### Overall Workflow
55+
### Overall workflow
5656

5757
Generating a PGO-optimized program involves the following four steps:
5858

@@ -62,12 +62,12 @@ Generating a PGO-optimized program involves the following four steps:
6262
4. Compile the program again, this time making use of the profiling data
6363
(e.g. `rustc -C profile-use=merged.profdata main.rs`)
6464

65-
### Compile-Time Aspects
65+
### Compile-time aspects
6666

6767
Depending on which step in the above workflow we are in, two different things
6868
can happen at compile time:
6969

70-
#### Create Binaries with Instrumentation
70+
#### Create binaries with instrumentation
7171

7272
As mentioned above, the profiling instrumentation is added by LLVM.
7373
`rustc` instructs LLVM to do so [by setting the appropriate][pgo-gen-passmanager]
@@ -88,7 +88,7 @@ runtime are not removed [by marking the with the right export level][pgo-gen-sym
8888
[pgo-gen-symbols]:https://github.com/rust-lang/rust/blob/1.34.1/src/librustc_codegen_ssa/back/symbol_export.rs#L212-L225
8989
9090
91-
#### Compile Binaries Where Optimizations Make Use Of Profiling Data
91+
#### Compile binaries where optimizations make use of profiling data
9292
9393
In the final step of the workflow described above, the program is compiled
9494
again, with the compiler using the gathered profiling data in order to drive
@@ -106,7 +106,7 @@ LLVM does the rest (e.g. setting branch weights, marking functions with
106106
`cold` or `inlinehint`, etc).
107107

108108

109-
### Runtime Aspects
109+
### Runtime aspects
110110

111111
Instrumentation-based approaches always also have a runtime component, i.e.
112112
once we have an instrumented program, that program needs to be run in order
@@ -134,7 +134,7 @@ instrumentation artifacts show up in LLVM IR.
134134
[rmake-tests]: https://github.com/rust-lang/rust/tree/master/tests/run-make
135135
[codegen-test]: https://github.com/rust-lang/rust/blob/master/tests/codegen/pgo-instrumentation.rs
136136

137-
## Additional Information
137+
## Additional information
138138

139139
Clang's documentation contains a good overview on [PGO in LLVM][llvm-pgo].
140140

src/sanitizers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Sanitizers Support
1+
# Sanitizers support
22

33
The rustc compiler contains support for following sanitizers:
44

0 commit comments

Comments
 (0)