Minor tweaks to rustc book summary formatting.

This commit is contained in:
Eric Huss 2022-05-19 19:06:01 -07:00
parent a09d36deae
commit 6eb41178c4
12 changed files with 23 additions and 23 deletions

View File

@ -1,19 +1,20 @@
# The Rustc Book # The Rustc Book
- [What is rustc?](what-is-rustc.md) - [What is rustc?](what-is-rustc.md)
- [Command-line arguments](command-line-arguments.md) - [Command-line Arguments](command-line-arguments.md)
- [Codegen Options](codegen-options/index.md)
- [Lints](lints/index.md) - [Lints](lints/index.md)
- [Lint levels](lints/levels.md) - [Lint Levels](lints/levels.md)
- [Lint Groups](lints/groups.md) - [Lint Groups](lints/groups.md)
- [Lint listing](lints/listing/index.md) - [Lint Listing](lints/listing/index.md)
- [Allowed-by-default lints](lints/listing/allowed-by-default.md) - [Allowed-by-default Lints](lints/listing/allowed-by-default.md)
- [Warn-by-default lints](lints/listing/warn-by-default.md) - [Warn-by-default Lints](lints/listing/warn-by-default.md)
- [Deny-by-default lints](lints/listing/deny-by-default.md) - [Deny-by-default Lints](lints/listing/deny-by-default.md)
- [Codegen options](codegen-options/index.md)
- [JSON Output](json.md) - [JSON Output](json.md)
- [Tests](tests/index.md) - [Tests](tests/index.md)
- [Platform Support](platform-support.md) - [Platform Support](platform-support.md)
- [Template for target-specific documentation](platform-support/TEMPLATE.md) - [Target Tier Policy](target-tier-policy.md)
- [Template for Target-specific Documentation](platform-support/TEMPLATE.md)
- [aarch64-apple-ios-sim](platform-support/aarch64-apple-ios-sim.md) - [aarch64-apple-ios-sim](platform-support/aarch64-apple-ios-sim.md)
- [armv7-unknown-linux-uclibceabi](platform-support/armv7-unknown-linux-uclibceabi.md) - [armv7-unknown-linux-uclibceabi](platform-support/armv7-unknown-linux-uclibceabi.md)
- [armv7-unknown-linux-uclibceabihf](platform-support/armv7-unknown-linux-uclibceabihf.md) - [armv7-unknown-linux-uclibceabihf](platform-support/armv7-unknown-linux-uclibceabihf.md)
@ -25,13 +26,12 @@
- [*-unknown-openbsd](platform-support/openbsd.md) - [*-unknown-openbsd](platform-support/openbsd.md)
- [wasm64-unknown-unknown](platform-support/wasm64-unknown-unknown.md) - [wasm64-unknown-unknown](platform-support/wasm64-unknown-unknown.md)
- [x86_64-unknown-none](platform-support/x86_64-unknown-none.md) - [x86_64-unknown-none](platform-support/x86_64-unknown-none.md)
- [Target Tier Policy](target-tier-policy.md)
- [Targets](targets/index.md) - [Targets](targets/index.md)
- [Built-in Targets](targets/built-in.md) - [Built-in Targets](targets/built-in.md)
- [Custom Targets](targets/custom.md) - [Custom Targets](targets/custom.md)
- [Known Issues](targets/known-issues.md) - [Known Issues](targets/known-issues.md)
- [Profile-guided Optimization](profile-guided-optimization.md) - [Profile-guided Optimization](profile-guided-optimization.md)
- [Instrumentation-based Code Coverage](instrument-coverage.md) - [Instrumentation-based Code Coverage](instrument-coverage.md)
- [Linker-plugin based LTO](linker-plugin-lto.md) - [Linker-plugin-based LTO](linker-plugin-lto.md)
- [Exploit Mitigations](exploit-mitigations.md) - [Exploit Mitigations](exploit-mitigations.md)
- [Contributing to `rustc`](contributing.md) - [Contributing to `rustc`](contributing.md)

View File

@ -1,4 +1,4 @@
# Codegen options # Codegen Options
All of these options are passed to `rustc` via the `-C` flag, short for "codegen." You can see All of these options are passed to `rustc` via the `-C` flag, short for "codegen." You can see
a version of this list for your exact compiler by running `rustc -C help`. a version of this list for your exact compiler by running `rustc -C help`.

View File

@ -1,4 +1,4 @@
# Command-line arguments # Command-line Arguments
Here's a list of command-line arguments to `rustc` and what they do. Here's a list of command-line arguments to `rustc` and what they do.

View File

@ -1,4 +1,4 @@
# `instrument-coverage` # Instrumentation-based Code Coverage
## Introduction ## Introduction

View File

@ -1,4 +1,4 @@
# Linker-plugin-LTO # Linker-plugin-based LTO
The `-C linker-plugin-lto` flag allows for deferring the LTO optimization The `-C linker-plugin-lto` flag allows for deferring the LTO optimization
to the actual linking step, which in turn allows for performing to the actual linking step, which in turn allows for performing

View File

@ -1,4 +1,4 @@
# Lint levels # Lint Levels
In `rustc`, lints are divided into five *levels*: In `rustc`, lints are divided into five *levels*:

View File

@ -1,3 +1,3 @@
# Allowed-by-default lints # Allowed-by-default Lints
This file is auto-generated by the lint-docs script. This file is auto-generated by the lint-docs script.

View File

@ -1,3 +1,3 @@
# Deny-by-default lints # Deny-by-default Lints
This file is auto-generated by the lint-docs script. This file is auto-generated by the lint-docs script.

View File

@ -1,4 +1,4 @@
# Lint listing # Lint Listing
This section lists out all of the lints, grouped by their default lint levels. This section lists out all of the lints, grouped by their default lint levels.

View File

@ -1,3 +1,3 @@
# Warn-by-default lints # Warn-by-default Lints
This file is auto-generated by the lint-docs script. This file is auto-generated by the lint-docs script.

View File

@ -1,4 +1,4 @@
# Profile Guided Optimization # Profile-guided Optimization
`rustc` supports doing profile-guided optimization (PGO). `rustc` supports doing profile-guided optimization (PGO).
This chapter describes what PGO is, what it is good for, and how it can be used. This chapter describes what PGO is, what it is good for, and how it can be used.

View File

@ -482,20 +482,20 @@ fn lint_name(line: &str) -> Result<String, &'static str> {
} }
} }
static ALLOWED_MD: &str = r#"# Allowed-by-default lints static ALLOWED_MD: &str = r#"# Allowed-by-default Lints
These lints are all set to the 'allow' level by default. As such, they won't show up These lints are all set to the 'allow' level by default. As such, they won't show up
unless you set them to a higher lint level with a flag or attribute. unless you set them to a higher lint level with a flag or attribute.
"#; "#;
static WARN_MD: &str = r#"# Warn-by-default lints static WARN_MD: &str = r#"# Warn-by-default Lints
These lints are all set to the 'warn' level by default. These lints are all set to the 'warn' level by default.
"#; "#;
static DENY_MD: &str = r#"# Deny-by-default lints static DENY_MD: &str = r#"# Deny-by-default Lints
These lints are all set to the 'deny' level by default. These lints are all set to the 'deny' level by default.