Thanks to visit codestin.com
Credit goes to github.com

Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
9aa572d
use consistent title capitalization
tshepang May 22, 2025
a4c8ef9
Adjust some doc for Query System
xizheyin Jun 13, 2025
067a99b
install docs for each target in different directory
Forist2034 Jun 13, 2025
94d56d1
Merge pull request #2441 from rust-lang/tshepang-remove-title-case
tshepang Jun 14, 2025
9265493
Merge pull request #2465 from xizheyin/rustc-query
tshepang Jun 14, 2025
a70deb6
content has moved to another chapter
tshepang Jun 14, 2025
9926215
Merge pull request #2466 from rust-lang/tshepang-moved
tshepang Jun 14, 2025
0834e48
use sentence case
tshepang Jun 14, 2025
a3f261c
Merge pull request #2467 from rust-lang/tshepang-patch-1
tshepang Jun 14, 2025
820e88a
title case
tshepang Jun 14, 2025
21a1e51
do not inline links
tshepang Jun 14, 2025
d16e1a1
Merge pull request #2468 from rust-lang/query-cleaning
tshepang Jun 14, 2025
808d16c
Use stage 1 for building docs
Darksonn Jun 16, 2025
3edb332
Merge pull request #2471 from Darksonn/patch-1
Noratrieb Jun 16, 2025
1dbf86a
Remove hanging parenthesis from example signature.
cbloodsworth Jun 16, 2025
02334e1
Merge pull request #2472 from cbloodsworth/fix/tytable_parens
BoxyUwU Jun 16, 2025
8bc55da
Profiling with perf: specify the section of bootstrap settings.
lolbinarycat Jun 17, 2025
671817f
Merge pull request #2475 from lolbinarycat/patch-3
Noratrieb Jun 17, 2025
d96b2d4
Stub chapter and consolidate under `/hir/`
BoxyUwU Jun 6, 2025
42888bb
Write chapter on Unambig vs Ambig Types/Consts
BoxyUwU Jun 17, 2025
c1506c0
Add links
BoxyUwU Jun 17, 2025
39e9800
Reviews
BoxyUwU Jun 18, 2025
6c7830e
Merge pull request #2474 from BoxyUwU/ambig_unambig_ty_consts
BoxyUwU Jun 18, 2025
4145596
fix markup
tshepang Jun 18, 2025
79652d9
Merge pull request #2476 from rust-lang/tshepang-patch-1
tshepang Jun 18, 2025
0a185e4
initial instructions for gpu offload
ZuseZ4 Jun 2, 2025
f25cfe8
Merge pull request #2447 from rust-lang/offload-docs
ZuseZ4 Jun 19, 2025
48b36ee
Preparing for merge from rustc
invalid-email-address Jun 19, 2025
d854d56
Merge from rustc
invalid-email-address Jun 19, 2025
8c28161
Add `get_host_target` function
Kobzol Jun 17, 2025
21d21d5
Normalize host target in snapshot tests
Kobzol Jun 17, 2025
718e475
Clarify arrow in snapshot tests
Kobzol Jun 18, 2025
eefd598
correct template for `#[align]`
folkertdev Jun 19, 2025
aca0688
De-dup common code from `ExternalCrate` methods
yotamofek Jun 19, 2025
6ad42bf
Merge pull request #2477 from rust-lang/rustc-pull
tshepang Jun 19, 2025
dfaa622
add issue template for rustdoc
lolbinarycat Jun 19, 2025
240dc05
Add a mailmap entry for y21
tgross35 Jun 19, 2025
fca6e81
Make sure to rebuild rustdoc if `src/rustdoc-json-types` is changed
jieyouxu Jun 19, 2025
42b0201
Fix `tests/ui/asm/naked-invalid-attr.stderr`.
nnethercote May 27, 2025
4a1f445
Use a symbol for `ExpansionConfig::crate_name`.
nnethercote May 29, 2025
1edf201
Avoid some unnecessary symbol interning.
nnethercote May 29, 2025
b95d39d
Remove an unnecessary check in rustfmt.
nnethercote May 27, 2025
75bcc9c
remove equivalent new method on context
jdonszelmann Jun 19, 2025
d475e10
Add temporary directory for executing snapshot tests
Kobzol Jun 20, 2025
88f1ed4
Convert `ilog(10)` to `ilog10()`
ChaiTRex Jun 20, 2025
aae966e
Rollup merge of #142478 - Forist2034:master, r=clubby789
Kobzol Jun 20, 2025
044b499
Rollup merge of #142629 - Kobzol:bootstrap-tests-builder, r=jieyouxu
Kobzol Jun 20, 2025
480ea7e
Rollup merge of #142715 - folkertdev:fn-align-corrections, r=jdonszel…
Kobzol Jun 20, 2025
99b850e
Rollup merge of #142720 - yotamofek:pr/rustdoc/ext-crate-cleanup, r=G…
Kobzol Jun 20, 2025
b638bec
Rollup merge of #142736 - lolbinarycat:rustdoc-issue-template, r=Guil…
Kobzol Jun 20, 2025
3a676cc
Rollup merge of #142743 - tshepang:rdg-push, r=jieyouxu
Kobzol Jun 20, 2025
509d289
Rollup merge of #142744 - tgross35:y21-mailmap, r=y21
Kobzol Jun 20, 2025
833efa1
Rollup merge of #142758 - jieyouxu:rustdoc-json-types, r=Kobzol
Kobzol Jun 20, 2025
8b8255b
Rollup merge of #142764 - ChaiTRex:ilog_10_to_ilog10, r=workingjubilee
Kobzol Jun 20, 2025
4c899b2
Rollup merge of #142767 - nnethercote:symbol-cleanups, r=petrochenkov
Kobzol Jun 20, 2025
7cb6acc
Rollup merge of #142769 - jdonszelmann:remove-useless-new-method, r=t…
Kobzol Jun 20, 2025
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
Next Next commit
use consistent title capitalization
  • Loading branch information
tshepang committed Jun 2, 2025
commit 9aa572d598b066fdf9e5a0ff72891288d87d006c
18 changes: 9 additions & 9 deletions src/doc/rustc-dev-guide/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,15 +181,15 @@
- [Significant changes and quirks](./solve/significant-changes.md)
- [`Unsize` and `CoerceUnsized` traits](./traits/unsize.md)
- [Type checking](./type-checking.md)
- [Method Lookup](./method-lookup.md)
- [Method lookup](./method-lookup.md)
- [Variance](./variance.md)
- [Coherence checking](./coherence.md)
- [Opaque types](./opaque-types-type-alias-impl-trait.md)
- [Inference details](./opaque-types-impl-trait-inference.md)
- [Return Position Impl Trait In Trait](./return-position-impl-trait-in-trait.md)
- [Region inference restrictions][opaque-infer]
- [Const condition checking](./effects.md)
- [Pattern and Exhaustiveness Checking](./pat-exhaustive-checking.md)
- [Pattern and exhaustiveness checking](./pat-exhaustive-checking.md)
- [Unsafety checking](./unsafety-checking.md)
- [MIR dataflow](./mir/dataflow.md)
- [Drop elaboration](./mir/drop-elaboration.md)
Expand All @@ -209,7 +209,7 @@
- [Closure capture inference](./closure.md)
- [Async closures/"coroutine-closures"](coroutine-closures.md)

# MIR to Binaries
# MIR to binaries

- [Prologue](./part-5-intro.md)
- [MIR optimizations](./mir/optimizations.md)
Expand All @@ -218,15 +218,15 @@
- [Interpreter](./const-eval/interpret.md)
- [Monomorphization](./backend/monomorph.md)
- [Lowering MIR](./backend/lowering-mir.md)
- [Code Generation](./backend/codegen.md)
- [Code generation](./backend/codegen.md)
- [Updating LLVM](./backend/updating-llvm.md)
- [Debugging LLVM](./backend/debugging.md)
- [Backend Agnostic Codegen](./backend/backend-agnostic.md)
- [Implicit Caller Location](./backend/implicit-caller-location.md)
- [Libraries and Metadata](./backend/libs-and-metadata.md)
- [Profile-guided Optimization](./profile-guided-optimization.md)
- [LLVM Source-Based Code Coverage](./llvm-coverage-instrumentation.md)
- [Sanitizers Support](./sanitizers.md)
- [Implicit caller location](./backend/implicit-caller-location.md)
- [Libraries and metadata](./backend/libs-and-metadata.md)
- [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)

---
Expand Down
12 changes: 6 additions & 6 deletions src/doc/rustc-dev-guide/src/backend/implicit-caller-location.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Implicit Caller Location
# Implicit caller location

<!-- toc -->

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

## Motivating Example
## Motivating example

Take this example program:

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

## Reading Caller Location
## Reading caller location

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

## Caller Location in `const`
## Caller location in `const`

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

### Dynamic Dispatch
### Dynamic dispatch

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

## The Attribute
## The attribute

The `#[track_caller]` attribute is checked alongside other codegen attributes to ensure the
function:
Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustc-dev-guide/src/backend/libs-and-metadata.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Libraries and Metadata
# Libraries and metadata

When the compiler sees a reference to an external crate, it needs to load some
information about that crate. This chapter gives an overview of that process,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# LLVM Source-Based Code Coverage
# LLVM source-based code coverage

<!-- toc -->

Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustc-dev-guide/src/part-5-intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# From MIR to Binaries
# From MIR to binaries

All of the preceding chapters of this guide have one thing in common:
we never generated any executable machine code at all!
Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustc-dev-guide/src/pat-exhaustive-checking.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Pattern and Exhaustiveness Checking
# Pattern and exhaustiveness checking

In Rust, pattern matching and bindings have a few very helpful properties. The
compiler will check that bindings are irrefutable when made and that match arms
Expand Down
16 changes: 8 additions & 8 deletions src/doc/rustc-dev-guide/src/profile-guided-optimization.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Profile Guided Optimization
# Profile-guided optimization

<!-- toc -->

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

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

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

### Overall Workflow
### Overall workflow

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

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

### Compile-Time Aspects
### Compile-time aspects

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

#### Create Binaries with Instrumentation
#### Create binaries with instrumentation

As mentioned above, the profiling instrumentation is added by LLVM.
`rustc` instructs LLVM to do so [by setting the appropriate][pgo-gen-passmanager]
Expand All @@ -88,7 +88,7 @@ runtime are not removed [by marking the with the right export level][pgo-gen-sym
[pgo-gen-symbols]:https://github.com/rust-lang/rust/blob/1.34.1/src/librustc_codegen_ssa/back/symbol_export.rs#L212-L225


#### Compile Binaries Where Optimizations Make Use Of Profiling Data
#### Compile binaries where optimizations make use of profiling data

In the final step of the workflow described above, the program is compiled
again, with the compiler using the gathered profiling data in order to drive
Expand All @@ -106,7 +106,7 @@ LLVM does the rest (e.g. setting branch weights, marking functions with
`cold` or `inlinehint`, etc).


### Runtime Aspects
### Runtime aspects

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

## Additional Information
## Additional information

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

Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustc-dev-guide/src/sanitizers.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sanitizers Support
# Sanitizers support

The rustc compiler contains support for following sanitizers:

Expand Down