about summary refs log tree commit diff
path: root/src/doc/rustc
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2022-05-20 19:54:42 +0200
committerGitHub <noreply@github.com>2022-05-20 19:54:42 +0200
commit7c46bb60d19262af4388a11e274d81b38469c85b (patch)
tree5b085276808cfe697853a47d7f319bb569522fd7 /src/doc/rustc
parent35986cd1fbbad3a4bcf370307c10cef178183444 (diff)
parent6eb41178c4d118692efe0e4928e0034f70235bf1 (diff)
downloadrust-7c46bb60d19262af4388a11e274d81b38469c85b.tar.gz
rust-7c46bb60d19262af4388a11e274d81b38469c85b.zip
Rollup merge of #97203 - ehuss:rustc-summary-formatting, r=Dylan-DPC
Minor tweaks to rustc book summary formatting.

This includes a few minor tweaks to the summary/titles of chapters for the rustc book:

* Use a consistent chapter capitalization and hyphenation.
* Move "Codegen Options" underneath "Command-line Arguments". I feel like they are two closely related chapters, where codegen is just a subset of the total arguments.
* Move "Target Tier Policy" underneath "Platform Support". That chapter includes that policy for platform support, and thus I feel it is more closely related to that grouping.
Diffstat (limited to 'src/doc/rustc')
-rw-r--r--src/doc/rustc/src/SUMMARY.md20
-rw-r--r--src/doc/rustc/src/codegen-options/index.md2
-rw-r--r--src/doc/rustc/src/command-line-arguments.md2
-rw-r--r--src/doc/rustc/src/instrument-coverage.md2
-rw-r--r--src/doc/rustc/src/linker-plugin-lto.md2
-rw-r--r--src/doc/rustc/src/lints/levels.md2
-rw-r--r--src/doc/rustc/src/lints/listing/allowed-by-default.md2
-rw-r--r--src/doc/rustc/src/lints/listing/deny-by-default.md2
-rw-r--r--src/doc/rustc/src/lints/listing/index.md2
-rw-r--r--src/doc/rustc/src/lints/listing/warn-by-default.md2
-rw-r--r--src/doc/rustc/src/profile-guided-optimization.md2
11 files changed, 20 insertions, 20 deletions
diff --git a/src/doc/rustc/src/SUMMARY.md b/src/doc/rustc/src/SUMMARY.md
index c2d44ac0e4d..7b2c35c0593 100644
--- a/src/doc/rustc/src/SUMMARY.md
+++ b/src/doc/rustc/src/SUMMARY.md
@@ -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)
@@ -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)
diff --git a/src/doc/rustc/src/codegen-options/index.md b/src/doc/rustc/src/codegen-options/index.md
index 02011325d68..b1c3b618cec 100644
--- a/src/doc/rustc/src/codegen-options/index.md
+++ b/src/doc/rustc/src/codegen-options/index.md
@@ -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`.
diff --git a/src/doc/rustc/src/command-line-arguments.md b/src/doc/rustc/src/command-line-arguments.md
index d80e4f20869..73e7764a11d 100644
--- a/src/doc/rustc/src/command-line-arguments.md
+++ b/src/doc/rustc/src/command-line-arguments.md
@@ -1,4 +1,4 @@
-# Command-line arguments
+# Command-line Arguments
 
 Here's a list of command-line arguments to `rustc` and what they do.
 
diff --git a/src/doc/rustc/src/instrument-coverage.md b/src/doc/rustc/src/instrument-coverage.md
index 108b0ffe99b..0ae9e53af3c 100644
--- a/src/doc/rustc/src/instrument-coverage.md
+++ b/src/doc/rustc/src/instrument-coverage.md
@@ -1,4 +1,4 @@
-# `instrument-coverage`
+# Instrumentation-based Code Coverage
 
 ## Introduction
 
diff --git a/src/doc/rustc/src/linker-plugin-lto.md b/src/doc/rustc/src/linker-plugin-lto.md
index e7bf8d9a36f..9c644dd404d 100644
--- a/src/doc/rustc/src/linker-plugin-lto.md
+++ b/src/doc/rustc/src/linker-plugin-lto.md
@@ -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
diff --git a/src/doc/rustc/src/lints/levels.md b/src/doc/rustc/src/lints/levels.md
index fbec3cd9baf..93892d6ade6 100644
--- a/src/doc/rustc/src/lints/levels.md
+++ b/src/doc/rustc/src/lints/levels.md
@@ -1,4 +1,4 @@
-# Lint levels
+# Lint Levels
 
 In `rustc`, lints are divided into five *levels*:
 
diff --git a/src/doc/rustc/src/lints/listing/allowed-by-default.md b/src/doc/rustc/src/lints/listing/allowed-by-default.md
index 95dd60bebfb..8c4c0b9c558 100644
--- a/src/doc/rustc/src/lints/listing/allowed-by-default.md
+++ b/src/doc/rustc/src/lints/listing/allowed-by-default.md
@@ -1,3 +1,3 @@
-# Allowed-by-default lints
+# Allowed-by-default Lints
 
 This file is auto-generated by the lint-docs script.
diff --git a/src/doc/rustc/src/lints/listing/deny-by-default.md b/src/doc/rustc/src/lints/listing/deny-by-default.md
index 3c1452d6467..12f511423b4 100644
--- a/src/doc/rustc/src/lints/listing/deny-by-default.md
+++ b/src/doc/rustc/src/lints/listing/deny-by-default.md
@@ -1,3 +1,3 @@
-# Deny-by-default lints
+# Deny-by-default Lints
 
 This file is auto-generated by the lint-docs script.
diff --git a/src/doc/rustc/src/lints/listing/index.md b/src/doc/rustc/src/lints/listing/index.md
index 97aa2caf915..791a80274e2 100644
--- a/src/doc/rustc/src/lints/listing/index.md
+++ b/src/doc/rustc/src/lints/listing/index.md
@@ -1,4 +1,4 @@
-# Lint listing
+# Lint Listing
 
 This section lists out all of the lints, grouped by their default lint levels.
 
diff --git a/src/doc/rustc/src/lints/listing/warn-by-default.md b/src/doc/rustc/src/lints/listing/warn-by-default.md
index eebc022a82b..84d67764f7d 100644
--- a/src/doc/rustc/src/lints/listing/warn-by-default.md
+++ b/src/doc/rustc/src/lints/listing/warn-by-default.md
@@ -1,3 +1,3 @@
-# Warn-by-default lints
+# Warn-by-default Lints
 
 This file is auto-generated by the lint-docs script.
diff --git a/src/doc/rustc/src/profile-guided-optimization.md b/src/doc/rustc/src/profile-guided-optimization.md
index d066f4a9cf5..d9cf7ce30f9 100644
--- a/src/doc/rustc/src/profile-guided-optimization.md
+++ b/src/doc/rustc/src/profile-guided-optimization.md
@@ -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.