Skip to content

Minor tweaks to rustc book summary formatting. #97203

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

Merged
merged 1 commit into from
May 20, 2022
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
20 changes: 10 additions & 10 deletions src/doc/rustc/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# The Rustc Book

- [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)
- [Lint levels](lints/levels.md)
- [Lint Levels](lints/levels.md)
- [Lint Groups](lints/groups.md)
- [Lint listing](lints/listing/index.md)
- [Allowed-by-default lints](lints/listing/allowed-by-default.md)
- [Warn-by-default lints](lints/listing/warn-by-default.md)
- [Deny-by-default lints](lints/listing/deny-by-default.md)
- [Codegen options](codegen-options/index.md)
- [Lint Listing](lints/listing/index.md)
- [Allowed-by-default Lints](lints/listing/allowed-by-default.md)
- [Warn-by-default Lints](lints/listing/warn-by-default.md)
- [Deny-by-default Lints](lints/listing/deny-by-default.md)
- [JSON Output](json.md)
- [Tests](tests/index.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)
- [armv7-unknown-linux-uclibceabi](platform-support/armv7-unknown-linux-uclibceabi.md)
- [armv7-unknown-linux-uclibceabihf](platform-support/armv7-unknown-linux-uclibceabihf.md)
Expand All @@ -25,13 +26,12 @@
- [*-unknown-openbsd](platform-support/openbsd.md)
- [wasm64-unknown-unknown](platform-support/wasm64-unknown-unknown.md)
- [x86_64-unknown-none](platform-support/x86_64-unknown-none.md)
- [Target Tier Policy](target-tier-policy.md)
- [Targets](targets/index.md)
- [Built-in Targets](targets/built-in.md)
- [Custom Targets](targets/custom.md)
- [Known Issues](targets/known-issues.md)
- [Profile-guided Optimization](profile-guided-optimization.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)
- [Contributing to `rustc`](contributing.md)
2 changes: 1 addition & 1 deletion src/doc/rustc/src/codegen-options/index.md
Original file line number Diff line number Diff line change
@@ -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
a version of this list for your exact compiler by running `rustc -C help`.
Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustc/src/command-line-arguments.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Command-line arguments
# Command-line Arguments

Here's a list of command-line arguments to `rustc` and what they do.

Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustc/src/instrument-coverage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# `instrument-coverage`
# Instrumentation-based Code Coverage

## Introduction

Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustc/src/linker-plugin-lto.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Linker-plugin-LTO
# Linker-plugin-based LTO

The `-C linker-plugin-lto` flag allows for deferring the LTO optimization
to the actual linking step, which in turn allows for performing
Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustc/src/lints/levels.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Lint levels
# Lint Levels

In `rustc`, lints are divided into five *levels*:

Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustc/src/lints/listing/allowed-by-default.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Allowed-by-default lints
# Allowed-by-default Lints

This file is auto-generated by the lint-docs script.
2 changes: 1 addition & 1 deletion src/doc/rustc/src/lints/listing/deny-by-default.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Deny-by-default lints
# Deny-by-default Lints

This file is auto-generated by the lint-docs script.
2 changes: 1 addition & 1 deletion src/doc/rustc/src/lints/listing/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Lint listing
# Lint Listing

This section lists out all of the lints, grouped by their default lint levels.

Expand Down
2 changes: 1 addition & 1 deletion src/doc/rustc/src/lints/listing/warn-by-default.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Warn-by-default lints
# Warn-by-default Lints

This file is auto-generated by the lint-docs script.
2 changes: 1 addition & 1 deletion src/doc/rustc/src/profile-guided-optimization.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Profile Guided Optimization
# Profile-guided Optimization

`rustc` supports doing profile-guided optimization (PGO).
This chapter describes what PGO is, what it is good for, and how it can be used.
Expand Down
6 changes: 3 additions & 3 deletions src/tools/lint-docs/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
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.

"#;

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.

Expand Down