From dbb22d247f201d9e2a3f07fa75f90db39e966ff7 Mon Sep 17 00:00:00 2001
From: Jane Lusby <jlusby@yaah.dev>
Date: Thu, 10 Mar 2022 16:59:08 -0800
Subject: [PATCH 01/10] update library tracking issue template

---
 .github/ISSUE_TEMPLATE/library_tracking_issue.md | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/.github/ISSUE_TEMPLATE/library_tracking_issue.md b/.github/ISSUE_TEMPLATE/library_tracking_issue.md
index 32fccfcfb16..91c06402ca1 100644
--- a/.github/ISSUE_TEMPLATE/library_tracking_issue.md
+++ b/.github/ISSUE_TEMPLATE/library_tracking_issue.md
@@ -50,7 +50,7 @@ If the feature is changed later, please add those PRs here as well.
 -->
 
 - [ ] Implementation: #...
-- [ ] Final comment period (FCP)
+- [ ] Final comment period (FCP)[^1]
 - [ ] Stabilization PR
 
 <!--
@@ -81,3 +81,5 @@ Zulip, or the internals forum) here.
 -->
 
 - None yet.
+
+[^1]: https://std-dev-guide.rust-lang.org/feature-lifecycle/stabilization.html

From 2852443f4877115c1c629d462cd83dae0baa7109 Mon Sep 17 00:00:00 2001
From: Michael Howell <michael@notriddle.com>
Date: Fri, 1 Jul 2022 10:33:06 -0700
Subject: [PATCH 02/10] rustdoc: use <details> tag for the source code sidebar

This fixes the extremely poor accessibility of the old system, making it
possible to navigate the sidebar by keyboard, and also implicitly gives the
sidebar items the correct ARIA roles.
---
 src/librustdoc/html/static/css/rustdoc.css    | 37 ++++------------
 src/librustdoc/html/static/css/themes/ayu.css |  3 +-
 .../html/static/css/themes/dark.css           |  3 +-
 .../html/static/css/themes/light.css          |  3 +-
 .../html/static/js/source-script.js           | 29 +++++--------
 .../sidebar-source-code-display.goml          | 42 +++++++++----------
 src/test/rustdoc-gui/source-code-page.goml    | 20 ++++-----
 7 files changed, 54 insertions(+), 83 deletions(-)

diff --git a/src/librustdoc/html/static/css/rustdoc.css b/src/librustdoc/html/static/css/rustdoc.css
index 532b98d9bb9..7d5318a194c 100644
--- a/src/librustdoc/html/static/css/rustdoc.css
+++ b/src/librustdoc/html/static/css/rustdoc.css
@@ -1528,37 +1528,18 @@ kbd {
 	margin-bottom: 1em;
 }
 
-div.children {
-	padding-left: 27px;
-	display: none;
-}
-div.name {
+details.dir-entry > summary {
+	margin: 0 0 0 13px;
+	list-style-position: outside;
 	cursor: pointer;
-	position: relative;
-	margin-left: 16px;
 }
-div.files > a {
+
+details.dir-entry div.folders, details.dir-entry div.files {
+	padding-left: 27px;
+}
+
+details.dir-entry a {
 	display: block;
-	padding: 0 3px;
-}
-div.files > a:hover, div.name:hover {
-	background-color: #a14b4b;
-}
-div.name.expand + .children {
-	display: block;
-}
-div.name::before {
-	content: "\25B6";
-	padding-left: 4px;
-	font-size: 0.625rem;
-	position: absolute;
-	left: -16px;
-	top: 4px;
-}
-div.name.expand::before {
-	transform: rotate(90deg);
-	left: -15px;
-	top: 2px;
 }
 
 /* The hideme class is used on summary tags that contain a span with
diff --git a/src/librustdoc/html/static/css/themes/ayu.css b/src/librustdoc/html/static/css/themes/ayu.css
index b7d0db1f002..a78ac5da749 100644
--- a/src/librustdoc/html/static/css/themes/ayu.css
+++ b/src/librustdoc/html/static/css/themes/ayu.css
@@ -630,7 +630,8 @@ kbd {
 	color: #fff;
 	border-bottom-color: #5c6773;
 }
-#source-sidebar div.files > a:hover, div.name:hover {
+#source-sidebar div.files > a:hover, details.dir-entry summary:hover,
+#source-sidebar div.files > a:focus, details.dir-entry summary:focus {
 	background-color: #14191f;
 	color: #ffb44c;
 }
diff --git a/src/librustdoc/html/static/css/themes/dark.css b/src/librustdoc/html/static/css/themes/dark.css
index eb64ef3e771..a2abd53fa02 100644
--- a/src/librustdoc/html/static/css/themes/dark.css
+++ b/src/librustdoc/html/static/css/themes/dark.css
@@ -500,7 +500,8 @@ kbd {
 #source-sidebar > .title {
 	border-bottom-color: #ccc;
 }
-#source-sidebar div.files > a:hover, div.name:hover {
+#source-sidebar div.files > a:hover, details.dir-entry summary:hover,
+#source-sidebar div.files > a:focus, details.dir-entry summary:focus {
 	background-color: #444;
 }
 #source-sidebar div.files > .selected {
diff --git a/src/librustdoc/html/static/css/themes/light.css b/src/librustdoc/html/static/css/themes/light.css
index 00cdf835897..c4510ad6ae6 100644
--- a/src/librustdoc/html/static/css/themes/light.css
+++ b/src/librustdoc/html/static/css/themes/light.css
@@ -484,7 +484,8 @@ kbd {
 #source-sidebar > .title {
 	border-bottom-color: #ccc;
 }
-#source-sidebar div.files > a:hover, div.name:hover {
+#source-sidebar div.files > a:hover, details.dir-entry summary:hover,
+#source-sidebar div.files > a:focus, details.dir-entry summary:focus {
 	background-color: #E0E0E0;
 }
 #source-sidebar div.files > .selected {
diff --git a/src/librustdoc/html/static/js/source-script.js b/src/librustdoc/html/static/js/source-script.js
index acb1d8d7b5c..21c36092790 100644
--- a/src/librustdoc/html/static/js/source-script.js
+++ b/src/librustdoc/html/static/js/source-script.js
@@ -13,33 +13,27 @@ const rootPath = document.getElementById("rustdoc-vars").attributes["data-root-p
 let oldScrollPosition = 0;
 
 function createDirEntry(elem, parent, fullPath, hasFoundFile) {
-    const name = document.createElement("div");
-    name.className = "name";
+    const dirEntry = document.createElement("details");
+    const summary = document.createElement("summary");
+
+    dirEntry.className = "dir-entry";
 
     fullPath += elem["name"] + "/";
 
-    name.onclick = ev => {
-        if (hasClass(ev.target, "expand")) {
-            removeClass(ev.target, "expand");
-        } else {
-            addClass(ev.target, "expand");
-        }
-    };
-    name.innerText = elem["name"];
+    summary.innerText = elem["name"];
+    dirEntry.appendChild(summary);
 
-    const children = document.createElement("div");
-    children.className = "children";
     const folders = document.createElement("div");
     folders.className = "folders";
     if (elem.dirs) {
         for (const dir of elem.dirs) {
             if (createDirEntry(dir, folders, fullPath, hasFoundFile)) {
-                addClass(name, "expand");
+                dirEntry.open = true;
                 hasFoundFile = true;
             }
         }
     }
-    children.appendChild(folders);
+    dirEntry.appendChild(folders);
 
     const files = document.createElement("div");
     files.className = "files";
@@ -51,15 +45,14 @@ function createDirEntry(elem, parent, fullPath, hasFoundFile) {
             const w = window.location.href.split("#")[0];
             if (!hasFoundFile && w === file.href) {
                 file.className = "selected";
-                addClass(name, "expand");
+                dirEntry.open = true;
                 hasFoundFile = true;
             }
             files.appendChild(file);
         }
     }
-    children.appendChild(files);
-    parent.appendChild(name);
-    parent.appendChild(children);
+    dirEntry.appendChild(files);
+    parent.appendChild(dirEntry);
     return hasFoundFile;
 }
 
diff --git a/src/test/rustdoc-gui/sidebar-source-code-display.goml b/src/test/rustdoc-gui/sidebar-source-code-display.goml
index c441f84a821..1d8cc22100c 100644
--- a/src/test/rustdoc-gui/sidebar-source-code-display.goml
+++ b/src/test/rustdoc-gui/sidebar-source-code-display.goml
@@ -27,29 +27,29 @@ reload:
 // Waiting for the sidebar to be displayed...
 wait-for-css: ("#sidebar-toggle", {"visibility": "visible", "opacity": 1})
 assert-css: (
-    "#source-sidebar .expand + .children a.selected",
+    "#source-sidebar details[open] > .files a.selected",
     {"color": "rgb(0, 0, 0)", "background-color": "rgb(255, 255, 255)"},
 )
 // Without hover.
 assert-css: (
-    "#source-sidebar .expand + .children > .files a:not(.selected)",
+    "#source-sidebar details[open] > .files a:not(.selected)",
     {"color": "rgb(0, 0, 0)", "background-color": "rgba(0, 0, 0, 0)"},
 )
 // With hover.
-move-cursor-to: "#source-sidebar .expand + .children > .files a:not(.selected)"
+move-cursor-to: "#source-sidebar details[open] > .files a:not(.selected)"
 assert-css: (
-    "#source-sidebar .expand + .children > .files a:not(.selected)",
+    "#source-sidebar details[open] > .files a:not(.selected)",
     {"color": "rgb(0, 0, 0)", "background-color": "rgb(224, 224, 224)"},
 )
 // Without hover.
 assert-css: (
-    "#source-sidebar .expand + .children .folders .name",
+    "#source-sidebar details[open] > .folders > details > summary",
     {"color": "rgb(0, 0, 0)", "background-color": "rgba(0, 0, 0, 0)"},
 )
 // With hover.
-move-cursor-to: "#source-sidebar .expand + .children .folders .name"
+move-cursor-to: "#source-sidebar details[open] > .folders > details > summary"
 assert-css: (
-    "#source-sidebar .expand + .children .folders .name",
+    "#source-sidebar details[open] > .folders > details > summary",
     {"color": "rgb(0, 0, 0)", "background-color": "rgb(224, 224, 224)"},
 )
 
@@ -59,29 +59,29 @@ reload:
 // Waiting for the sidebar to be displayed...
 wait-for-css: ("#sidebar-toggle", {"visibility": "visible", "opacity": 1})
 assert-css: (
-    "#source-sidebar .expand + .children a.selected",
+    "#source-sidebar details[open] > .files > a.selected",
     {"color": "rgb(221, 221, 221)", "background-color": "rgb(51, 51, 51)"},
 )
 // Without hover.
 assert-css: (
-    "#source-sidebar .expand + .children > .files a:not(.selected)",
+    "#source-sidebar details[open] > .files > a:not(.selected)",
     {"color": "rgb(221, 221, 221)", "background-color": "rgba(0, 0, 0, 0)"},
 )
 // With hover.
-move-cursor-to: "#source-sidebar .expand + .children > .files a:not(.selected)"
+move-cursor-to: "#source-sidebar details[open] > .files a:not(.selected)"
 assert-css: (
-    "#source-sidebar .expand + .children > .files a:not(.selected)",
+    "#source-sidebar details[open] > .files a:not(.selected)",
     {"color": "rgb(221, 221, 221)", "background-color": "rgb(68, 68, 68)"},
 )
 // Without hover.
 assert-css: (
-    "#source-sidebar .expand + .children .folders .name",
+    "#source-sidebar details[open] > .folders > details > summary",
     {"color": "rgb(221, 221, 221)", "background-color": "rgba(0, 0, 0, 0)"},
 )
 // With hover.
-move-cursor-to: "#source-sidebar .expand + .children .folders .name"
+move-cursor-to: "#source-sidebar details[open] > .folders > details > summary"
 assert-css: (
-    "#source-sidebar .expand + .children .folders .name",
+    "#source-sidebar details[open] > .folders > details > summary",
     {"color": "rgb(221, 221, 221)", "background-color": "rgb(68, 68, 68)"},
 )
 
@@ -91,29 +91,29 @@ reload:
 // Waiting for the sidebar to be displayed...
 wait-for-css: ("#sidebar-toggle", {"visibility": "visible", "opacity": 1})
 assert-css: (
-    "#source-sidebar .expand + .children a.selected",
+    "#source-sidebar details[open] > .files a.selected",
     {"color": "rgb(255, 180, 76)", "background-color": "rgb(20, 25, 31)"},
 )
 // Without hover.
 assert-css: (
-    "#source-sidebar .expand + .children > .files a:not(.selected)",
+    "#source-sidebar details[open] > .files a:not(.selected)",
     {"color": "rgb(197, 197, 197)", "background-color": "rgba(0, 0, 0, 0)"},
 )
 // With hover.
-move-cursor-to: "#source-sidebar .expand + .children > .files a:not(.selected)"
+move-cursor-to: "#source-sidebar details[open] > .files a:not(.selected)"
 assert-css: (
-    "#source-sidebar .expand + .children > .files a:not(.selected)",
+    "#source-sidebar details[open] > .files a:not(.selected)",
     {"color": "rgb(255, 180, 76)", "background-color": "rgb(20, 25, 31)"},
 )
 // Without hover.
 assert-css: (
-    "#source-sidebar .expand + .children .folders .name",
+    "#source-sidebar details[open] > .folders > details > summary",
     {"color": "rgb(197, 197, 197)", "background-color": "rgba(0, 0, 0, 0)"},
 )
 // With hover.
-move-cursor-to: "#source-sidebar .expand + .children .folders .name"
+move-cursor-to: "#source-sidebar details[open] > .folders > details > summary"
 assert-css: (
-    "#source-sidebar .expand + .children .folders .name",
+    "#source-sidebar details[open] > .folders > details > summary",
     {"color": "rgb(255, 180, 76)", "background-color": "rgb(20, 25, 31)"},
 )
 
diff --git a/src/test/rustdoc-gui/source-code-page.goml b/src/test/rustdoc-gui/source-code-page.goml
index b45512601f2..05b0e809bca 100644
--- a/src/test/rustdoc-gui/source-code-page.goml
+++ b/src/test/rustdoc-gui/source-code-page.goml
@@ -34,19 +34,13 @@ assert-document-property: ({"URL": "/lib.rs.html"}, ENDS_WITH)
 click: "#sidebar-toggle"
 assert: ".source-sidebar-expanded"
 
-// We check that the first entry of the sidebar is collapsed (which, for whatever reason,
-// is number 2 and not 1...).
-assert-attribute: ("#source-sidebar .name:nth-child(2)", {"class": "name"})
-assert-text: ("#source-sidebar .name:nth-child(2)", "implementors")
-// We also check its children are hidden too.
-assert-css: ("#source-sidebar .name:nth-child(2) + .children", {"display": "none"})
+// We check that the first entry of the sidebar is collapsed
+assert-property: ("#source-sidebar details:first-of-type", {"open": "false"})
+assert-text: ("#source-sidebar details:first-of-type > summary", "implementors")
 // We now click on it.
-click: "#source-sidebar .name:nth-child(2)"
-assert-attribute: ("#source-sidebar .name:nth-child(2)", {"class": "name expand"})
-// Checking that its children are displayed as well.
-assert-css: ("#source-sidebar .name:nth-child(2) + .children", {"display": "block"})
+click: "#source-sidebar details:first-of-type > summary"
+assert-property: ("#source-sidebar details:first-of-type", {"open": "true"})
 
 // And now we collapse it again.
-click: "#source-sidebar .name:nth-child(2)"
-assert-attribute: ("#source-sidebar .name:nth-child(2)", {"class": "name"})
-assert-css: ("#source-sidebar .name:nth-child(2) + .children", {"display": "none"})
+click: "#source-sidebar details:first-of-type > summary"
+assert-property: ("#source-sidebar details:first-of-type", {"open": "false"})

From 1f621fba2d7ef850b5d1920ef2bf37c7fa89570c Mon Sep 17 00:00:00 2001
From: Michael Howell <michael@notriddle.com>
Date: Fri, 1 Jul 2022 11:27:09 -0700
Subject: [PATCH 03/10] rustdoc cleanup: remove unused function

---
 src/librustdoc/html/static/css/themes/ayu.css   | 2 +-
 src/librustdoc/html/static/css/themes/dark.css  | 2 +-
 src/librustdoc/html/static/css/themes/light.css | 3 +--
 src/librustdoc/html/static/js/source-script.js  | 2 +-
 4 files changed, 4 insertions(+), 5 deletions(-)

diff --git a/src/librustdoc/html/static/css/themes/ayu.css b/src/librustdoc/html/static/css/themes/ayu.css
index a78ac5da749..63f64dc69e8 100644
--- a/src/librustdoc/html/static/css/themes/ayu.css
+++ b/src/librustdoc/html/static/css/themes/ayu.css
@@ -635,7 +635,7 @@ kbd {
 	background-color: #14191f;
 	color: #ffb44c;
 }
-#source-sidebar div.files > .selected {
+#source-sidebar div.files > a.selected {
 	background-color: #14191f;
 	color: #ffb44c;
 }
diff --git a/src/librustdoc/html/static/css/themes/dark.css b/src/librustdoc/html/static/css/themes/dark.css
index a2abd53fa02..d1f79b5b082 100644
--- a/src/librustdoc/html/static/css/themes/dark.css
+++ b/src/librustdoc/html/static/css/themes/dark.css
@@ -504,7 +504,7 @@ kbd {
 #source-sidebar div.files > a:focus, details.dir-entry summary:focus {
 	background-color: #444;
 }
-#source-sidebar div.files > .selected {
+#source-sidebar div.files > a.selected {
 	background-color: #333;
 }
 
diff --git a/src/librustdoc/html/static/css/themes/light.css b/src/librustdoc/html/static/css/themes/light.css
index c4510ad6ae6..e09b1f7a5e2 100644
--- a/src/librustdoc/html/static/css/themes/light.css
+++ b/src/librustdoc/html/static/css/themes/light.css
@@ -488,10 +488,9 @@ kbd {
 #source-sidebar div.files > a:focus, details.dir-entry summary:focus {
 	background-color: #E0E0E0;
 }
-#source-sidebar div.files > .selected {
+#source-sidebar div.files > a.selected {
 	background-color: #fff;
 }
-
 .scraped-example-list .scrape-help {
 	border-color: #555;
 	color: #333;
diff --git a/src/librustdoc/html/static/js/source-script.js b/src/librustdoc/html/static/js/source-script.js
index 21c36092790..9173e93e7c8 100644
--- a/src/librustdoc/html/static/js/source-script.js
+++ b/src/librustdoc/html/static/js/source-script.js
@@ -2,7 +2,7 @@
 /* global sourcesIndex */
 
 // Local js definitions:
-/* global addClass, getCurrentValue, hasClass, onEachLazy, removeClass, browserSupportsHistoryApi */
+/* global addClass, getCurrentValue, onEachLazy, removeClass, browserSupportsHistoryApi */
 /* global updateLocalStorage */
 
 "use strict";

From 180f83605afbd8abe58e79df475df0e0958401b3 Mon Sep 17 00:00:00 2001
From: Michael Howell <michael@notriddle.com>
Date: Fri, 1 Jul 2022 15:29:47 -0700
Subject: [PATCH 04/10] rustdoc: add spacing to the source view sidebar

https://user-images.githubusercontent.com/1593513/176974336-20cecdc3-1885-402a-a6d5-81a8dd03a45d.png
---
 src/librustdoc/html/static/css/rustdoc.css | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/librustdoc/html/static/css/rustdoc.css b/src/librustdoc/html/static/css/rustdoc.css
index 7d5318a194c..4e9b75eba6a 100644
--- a/src/librustdoc/html/static/css/rustdoc.css
+++ b/src/librustdoc/html/static/css/rustdoc.css
@@ -1528,6 +1528,10 @@ kbd {
 	margin-bottom: 1em;
 }
 
+details.dir-entry {
+	padding-left: 4px;
+}
+
 details.dir-entry > summary {
 	margin: 0 0 0 13px;
 	list-style-position: outside;
@@ -1535,7 +1539,7 @@ details.dir-entry > summary {
 }
 
 details.dir-entry div.folders, details.dir-entry div.files {
-	padding-left: 27px;
+	padding-left: 23px;
 }
 
 details.dir-entry a {

From b80979416d3eb7aa55c3f01b107f17f0363bf92e Mon Sep 17 00:00:00 2001
From: Michael Howell <michael@notriddle.com>
Date: Fri, 1 Jul 2022 16:16:03 -0700
Subject: [PATCH 05/10] rustdoc: add test cases for :focus on sidebar details
 elements

---
 .../sidebar-source-code-display.goml          | 42 +++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/src/test/rustdoc-gui/sidebar-source-code-display.goml b/src/test/rustdoc-gui/sidebar-source-code-display.goml
index 1d8cc22100c..edcd98dfd93 100644
--- a/src/test/rustdoc-gui/sidebar-source-code-display.goml
+++ b/src/test/rustdoc-gui/sidebar-source-code-display.goml
@@ -35,6 +35,13 @@ assert-css: (
     "#source-sidebar details[open] > .files a:not(.selected)",
     {"color": "rgb(0, 0, 0)", "background-color": "rgba(0, 0, 0, 0)"},
 )
+// With focus.
+focus: "#source-sidebar details[open] > .files a:not(.selected)"
+wait-for-css: (
+    "#source-sidebar details[open] > .files a:not(.selected)",
+    {"color": "rgb(0, 0, 0)", "background-color": "rgb(224, 224, 224)"},
+)
+focus: ".search-input"
 // With hover.
 move-cursor-to: "#source-sidebar details[open] > .files a:not(.selected)"
 assert-css: (
@@ -46,6 +53,13 @@ assert-css: (
     "#source-sidebar details[open] > .folders > details > summary",
     {"color": "rgb(0, 0, 0)", "background-color": "rgba(0, 0, 0, 0)"},
 )
+// With focus.
+focus: "#source-sidebar details[open] > .folders > details > summary"
+wait-for-css: (
+    "#source-sidebar details[open] > .folders > details > summary",
+    {"color": "rgb(0, 0, 0)", "background-color": "rgb(224, 224, 224)"},
+)
+focus: ".search-input"
 // With hover.
 move-cursor-to: "#source-sidebar details[open] > .folders > details > summary"
 assert-css: (
@@ -67,6 +81,13 @@ assert-css: (
     "#source-sidebar details[open] > .files > a:not(.selected)",
     {"color": "rgb(221, 221, 221)", "background-color": "rgba(0, 0, 0, 0)"},
 )
+// With focus.
+focus: "#source-sidebar details[open] > .files a:not(.selected)"
+wait-for-css: (
+    "#source-sidebar details[open] > .files a:not(.selected)",
+    {"color": "rgb(221, 221, 221)", "background-color": "rgb(68, 68, 68)"},
+)
+focus: ".search-input"
 // With hover.
 move-cursor-to: "#source-sidebar details[open] > .files a:not(.selected)"
 assert-css: (
@@ -78,6 +99,13 @@ assert-css: (
     "#source-sidebar details[open] > .folders > details > summary",
     {"color": "rgb(221, 221, 221)", "background-color": "rgba(0, 0, 0, 0)"},
 )
+// With focus.
+focus: "#source-sidebar details[open] > .folders > details > summary"
+wait-for-css: (
+    "#source-sidebar details[open] > .folders > details > summary",
+    {"color": "rgb(221, 221, 221)", "background-color": "rgb(68, 68, 68)"},
+)
+focus: ".search-input"
 // With hover.
 move-cursor-to: "#source-sidebar details[open] > .folders > details > summary"
 assert-css: (
@@ -99,6 +127,13 @@ assert-css: (
     "#source-sidebar details[open] > .files a:not(.selected)",
     {"color": "rgb(197, 197, 197)", "background-color": "rgba(0, 0, 0, 0)"},
 )
+// With focus.
+focus: "#source-sidebar details[open] > .files a:not(.selected)"
+wait-for-css: (
+    "#source-sidebar details[open] > .files a:not(.selected)",
+    {"color": "rgb(255, 180, 76)", "background-color": "rgb(20, 25, 31)"},
+)
+focus: ".search-input"
 // With hover.
 move-cursor-to: "#source-sidebar details[open] > .files a:not(.selected)"
 assert-css: (
@@ -110,6 +145,13 @@ assert-css: (
     "#source-sidebar details[open] > .folders > details > summary",
     {"color": "rgb(197, 197, 197)", "background-color": "rgba(0, 0, 0, 0)"},
 )
+// With focus.
+focus: "#source-sidebar details[open] > .folders > details > summary"
+wait-for-css: (
+    "#source-sidebar details[open] > .folders > details > summary",
+    {"color": "rgb(255, 180, 76)", "background-color": "rgb(20, 25, 31)"},
+)
+focus: ".search-input"
 // With hover.
 move-cursor-to: "#source-sidebar details[open] > .folders > details > summary"
 assert-css: (

From 17da4e06f20a47a68fe0a71607a66d7f9a4c850b Mon Sep 17 00:00:00 2001
From: Joshua Nelson <jnelson@cloudflare.com>
Date: Sat, 2 Jul 2022 00:54:05 -0500
Subject: [PATCH 06/10] Fix bug in `rustdoc -Whelp`

Previously, this printed the debugging options, not the lint options,
and only handled `-Whelp`, not `-A/-D/-F`.

This also fixes a few other misc issues:
- Fix `// check-stdout` for UI tests; previously it only worked for run-fail and compile-fail tests
- Add lint headers for tool lints, not just builtin lints
- Remove duplicate run-make test
---
 compiler/rustc_driver/src/lib.rs              |  20 +-
 src/librustdoc/config.rs                      |  22 +-
 src/librustdoc/lib.rs                         |  27 ++-
 .../run-make/issue-88756-opt-help/Makefile    |   4 -
 .../run-make/issue-88756-opt-help/README.md   |   1 -
 .../output-default.stdout                     | 193 ----------------
 src/test/run-make/issue-88756-opt-help/x.rs   |   1 -
 .../rustdoc-ui/issue-83883-describe-lints.rs  |   4 +-
 .../issue-83883-describe-lints.stdout         | 215 ++----------------
 src/tools/compiletest/src/runtest.rs          |   6 +-
 10 files changed, 70 insertions(+), 423 deletions(-)
 delete mode 100644 src/test/run-make/issue-88756-opt-help/Makefile
 delete mode 100644 src/test/run-make/issue-88756-opt-help/README.md
 delete mode 100644 src/test/run-make/issue-88756-opt-help/output-default.stdout
 delete mode 100644 src/test/run-make/issue-88756-opt-help/x.rs

diff --git a/compiler/rustc_driver/src/lib.rs b/compiler/rustc_driver/src/lib.rs
index 3096af90d47..b71cdad718a 100644
--- a/compiler/rustc_driver/src/lib.rs
+++ b/compiler/rustc_driver/src/lib.rs
@@ -849,10 +849,10 @@ Available lint options:
     };
 
     println!("Lint checks provided by rustc:\n");
-    println!("    {}  {:7.7}  {}", padded("name"), "default", "meaning");
-    println!("    {}  {:7.7}  {}", padded("----"), "-------", "-------");
 
     let print_lints = |lints: Vec<&Lint>| {
+        println!("    {}  {:7.7}  {}", padded("name"), "default", "meaning");
+        println!("    {}  {:7.7}  {}", padded("----"), "-------", "-------");
         for lint in lints {
             let name = lint.name_lower().replace('_', "-");
             println!(
@@ -884,11 +884,15 @@ Available lint options:
     };
 
     println!("Lint groups provided by rustc:\n");
-    println!("    {}  sub-lints", padded("name"));
-    println!("    {}  ---------", padded("----"));
-    println!("    {}  all lints that are set to issue warnings", padded("warnings"));
 
-    let print_lint_groups = |lints: Vec<(&'static str, Vec<LintId>)>| {
+    let print_lint_groups = |lints: Vec<(&'static str, Vec<LintId>)>, all_warnings| {
+        println!("    {}  sub-lints", padded("name"));
+        println!("    {}  ---------", padded("----"));
+
+        if all_warnings {
+            println!("    {}  all lints that are set to issue warnings", padded("warnings"));
+        }
+
         for (name, to) in lints {
             let name = name.to_lowercase().replace('_', "-");
             let desc = to
@@ -901,7 +905,7 @@ Available lint options:
         println!("\n");
     };
 
-    print_lint_groups(builtin_groups);
+    print_lint_groups(builtin_groups, true);
 
     match (loaded_plugins, plugin.len(), plugin_groups.len()) {
         (false, 0, _) | (false, _, 0) => {
@@ -916,7 +920,7 @@ Available lint options:
             }
             if g > 0 {
                 println!("Lint groups provided by plugins loaded by this crate:\n");
-                print_lint_groups(plugin_groups);
+                print_lint_groups(plugin_groups, false);
             }
         }
     }
diff --git a/src/librustdoc/config.rs b/src/librustdoc/config.rs
index 50d154dd278..04638aa1af6 100644
--- a/src/librustdoc/config.rs
+++ b/src/librustdoc/config.rs
@@ -353,11 +353,7 @@ impl Options {
             print_flag_list("-C", config::CG_OPTIONS);
             return Err(0);
         }
-        let w_flags = matches.opt_strs("W");
-        if w_flags.iter().any(|x| *x == "help") {
-            print_flag_list("-W", config::DB_OPTIONS);
-            return Err(0);
-        }
+
         if matches.opt_strs("passes") == ["list"] {
             println!("Available passes for running rustdoc:");
             for pass in passes::PASSES {
@@ -439,15 +435,19 @@ impl Options {
             return Err(0);
         }
 
-        if matches.free.is_empty() {
+        let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
+
+        let input = PathBuf::from(if describe_lints {
+            "" // dummy, this won't be used
+        } else if matches.free.is_empty() {
             diag.struct_err("missing file operand").emit();
             return Err(1);
-        }
-        if matches.free.len() > 1 {
+        } else if matches.free.len() > 1 {
             diag.struct_err("too many file operands").emit();
             return Err(1);
-        }
-        let input = PathBuf::from(&matches.free[0]);
+        } else {
+            &matches.free[0]
+        });
 
         let libs = matches
             .opt_strs("L")
@@ -698,8 +698,6 @@ impl Options {
         let with_examples = matches.opt_strs("with-examples");
         let call_locations = crate::scrape_examples::load_call_locations(with_examples, &diag)?;
 
-        let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
-
         Ok(Options {
             input,
             proc_macro_crate,
diff --git a/src/librustdoc/lib.rs b/src/librustdoc/lib.rs
index db4c3d10237..1854a1ffb90 100644
--- a/src/librustdoc/lib.rs
+++ b/src/librustdoc/lib.rs
@@ -76,7 +76,7 @@ use std::env::{self, VarError};
 use std::io;
 use std::process;
 
-use rustc_driver::{abort_on_err, describe_lints};
+use rustc_driver::abort_on_err;
 use rustc_errors::ErrorGuaranteed;
 use rustc_interface::interface;
 use rustc_middle::ty::TyCtxt;
@@ -771,15 +771,24 @@ fn main_options(options: config::Options) -> MainResult {
     let config = core::create_config(options);
 
     interface::create_compiler_and_run(config, |compiler| {
+        let sess = compiler.session();
+
+        if sess.opts.describe_lints {
+            let mut lint_store = rustc_lint::new_lint_store(
+                sess.opts.debugging_opts.no_interleave_lints,
+                sess.unstable_options(),
+            );
+            let registered_lints = if let Some(register_lints) = compiler.register_lints() {
+                register_lints(sess, &mut lint_store);
+                true
+            } else {
+                false
+            };
+            rustc_driver::describe_lints(sess, &lint_store, registered_lints);
+            return Ok(());
+        }
+
         compiler.enter(|queries| {
-            let sess = compiler.session();
-
-            if sess.opts.describe_lints {
-                let (_, lint_store) = &*queries.register_plugins()?.peek();
-                describe_lints(sess, lint_store, true);
-                return Ok(());
-            }
-
             // We need to hold on to the complete resolver, so we cause everything to be
             // cloned for the analysis passes to use. Suboptimal, but necessary in the
             // current architecture.
diff --git a/src/test/run-make/issue-88756-opt-help/Makefile b/src/test/run-make/issue-88756-opt-help/Makefile
deleted file mode 100644
index 8ababbf5b4e..00000000000
--- a/src/test/run-make/issue-88756-opt-help/Makefile
+++ /dev/null
@@ -1,4 +0,0 @@
--include ../../run-make-fulldeps/tools.mk
-
-all:
-	$(RUSTDOC) -W help 2>&1 | diff - output-default.stdout
diff --git a/src/test/run-make/issue-88756-opt-help/README.md b/src/test/run-make/issue-88756-opt-help/README.md
deleted file mode 100644
index 9b742753f25..00000000000
--- a/src/test/run-make/issue-88756-opt-help/README.md
+++ /dev/null
@@ -1 +0,0 @@
-This is a test to verify that `rustdoc` behaves the same as rustc and prints out help output for its options like -W (#88756).
diff --git a/src/test/run-make/issue-88756-opt-help/output-default.stdout b/src/test/run-make/issue-88756-opt-help/output-default.stdout
deleted file mode 100644
index 5cb7ecb649a..00000000000
--- a/src/test/run-make/issue-88756-opt-help/output-default.stdout
+++ /dev/null
@@ -1,193 +0,0 @@
-    -W                          allow-features=val -- only allow the listed language features to be enabled in code (space separated)
-    -W                       always-encode-mir=val -- encode MIR of all functions into the crate metadata (default: no)
-    -W               assume-incomplete-release=val -- make cfg(version) treat the current version as incomplete (default: no)
-    -W                            asm-comments=val -- generate comments into the assembly (may change behavior) (default: no)
-    -W                       assert-incr-state=val -- assert that the incremental cache is in given state: either `loaded` or `not-loaded`.
-    -W                      binary-dep-depinfo=val -- include artifacts (sysroot, crate dependencies) used during compilation in dep-info (default: no)
-    -W                       branch-protection=val -- set options for branch target identification and pointer authentication on AArch64
-    -W                           cf-protection=val -- instrument control-flow architecture protection
-    -W               cgu-partitioning-strategy=val -- the codegen unit partitioning strategy to use
-    -W                                   chalk=val -- enable the experimental Chalk-based trait solving engine
-    -W                         codegen-backend=val -- the backend to use
-    -W                             combine-cgu=val -- combine CGUs into a single one
-    -W                              crate-attr=val -- inject the given attribute in the crate
-    -W                debug-info-for-profiling=val -- emit discriminators and other data necessary for AutoFDO
-    -W                            debug-macros=val -- emit line numbers debug info inside macros (default: no)
-    -W                 deduplicate-diagnostics=val -- deduplicate identical diagnostics (default: yes)
-    -W                  dep-info-omit-d-target=val -- in dep-info output, omit targets for tracking dependencies of the dep-info files themselves (default: no)
-    -W                               dep-tasks=val -- print tasks that execute and the color their dep node gets (requires debug build) (default: no)
-    -W                                 dlltool=val -- import library generation tool (windows-gnu only)
-    -W                 dont-buffer-diagnostics=val -- emit diagnostics rather than buffering (breaks NLL error downgrading, sorting) (default: no)
-    -W                           drop-tracking=val -- enables drop tracking in generators (default: no)
-    -W                        dual-proc-macros=val -- load proc macros for both target and host, but only link to the target (default: no)
-    -W                          dump-dep-graph=val -- dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv) (default: no)
-    -W                                dump-mir=val -- dump MIR state to file.
-        `val` is used to select which passes and functions to dump. For example:
-        `all` matches all passes and functions,
-        `foo` matches all passes for functions whose name contains 'foo',
-        `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
-        `foo | bar` all passes for function names containing 'foo' or 'bar'.
-    -W                       dump-mir-dataflow=val -- in addition to `.mir` files, create graphviz `.dot` files with dataflow results (default: no)
-    -W                            dump-mir-dir=val -- the directory the MIR is dumped into (default: `mir_dump`)
-    -W            dump-mir-exclude-pass-number=val -- exclude the pass number when dumping MIR (used in tests) (default: no)
-    -W                       dump-mir-graphviz=val -- in addition to `.mir` files, create graphviz `.dot` files (and with `-Z instrument-coverage`, also create a `.dot` file for the MIR-derived coverage graph) (default: no)
-    -W                       dump-mir-spanview=val -- in addition to `.mir` files, create `.html` files to view spans for all `statement`s (including terminators), only `terminator` spans, or computed `block` spans (one span encompassing a block's terminator and all statements). If `-Z instrument-coverage` is also enabled, create an additional `.html` file showing the computed coverage spans.
-    -W                        emit-stack-sizes=val -- emit a section containing stack size metadata (default: no)
-    -W                             fewer-names=val -- reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR) (default: no)
-    -W              force-unstable-if-unmarked=val -- force all crates to be `rustc_private` unstable (default: no)
-    -W                                    fuel=val -- set the optimization fuel quota for a crate
-    -W                       function-sections=val -- whether each function should go in its own section
-    -W                    future-incompat-test=val -- forces all lints to be future incompatible, used for internal testing (default: no)
-    -W                                  gcc-ld=val -- implementation of ld used by cc
-    -W                      graphviz-dark-mode=val -- use dark-themed colors in graphviz output (default: no)
-    -W                           graphviz-font=val -- use the given `fontname` in graphviz output; can be overridden by setting environment variable `RUSTC_GRAPHVIZ_FONT` (default: `Courier, monospace`)
-    -W                               hir-stats=val -- print some statistics about AST and HIR (default: no)
-    -W                human-readable-cgu-names=val -- generate human-readable, predictable names for codegen units (default: no)
-    -W                        identify-regions=val -- display unnamed regions as `'<id>`, using a non-ident unique id (default: no)
-    -W                incremental-ignore-spans=val -- ignore spans during ICH computation -- used for testing (default: no)
-    -W                        incremental-info=val -- print high-level information about incremental reuse (or the lack thereof) (default: no)
-    -W              incremental-relative-spans=val -- hash spans relative to their parent item for incr. comp. (default: no)
-    -W                  incremental-verify-ich=val -- verify incr. comp. hashes of green query instances (default: no)
-    -W                              inline-mir=val -- enable MIR inlining (default: no)
-    -W                    inline-mir-threshold=val -- a default MIR inlining threshold (default: 50)
-    -W               inline-mir-hint-threshold=val -- inlining threshold for functions with inline hint (default: 100)
-    -W                      inline-in-all-cgus=val -- control whether `#[inline]` functions are in all CGUs
-    -W                             input-stats=val -- gather statistics about the input (default: no)
-    -W                     instrument-coverage=val -- instrument the generated code to support LLVM source-based code coverage reports (note, the compiler build config must include `profiler = true`); implies `-C symbol-mangling-version=v0`. Optional values are:
-        `=all` (implicit value)
-        `=except-unused-generics`
-        `=except-unused-functions`
-        `=off` (default)
-    -W                       instrument-mcount=val -- insert function instrument code for mcount-based tracing (default: no)
-    -W                       keep-hygiene-data=val -- keep hygiene data after analysis (default: no)
-    -W                   link-native-libraries=val -- link native libraries in the linker invocation (default: yes)
-    -W                               link-only=val -- link the `.rlink` file generated by `-Z no-link` (default: no)
-    -W                            llvm-plugins=val -- a list LLVM plugins to enable (space separated)
-    -W                         llvm-time-trace=val -- generate JSON tracing data file from LLVM data (default: no)
-    -W                         location-detail=val -- comma separated list of location details to be tracked when using caller_location valid options are `file`, `line`, and `column` (default: all)
-    -W                                      ls=val -- list the symbols defined by a library crate (default: no)
-    -W                         macro-backtrace=val -- show macro backtraces (default: no)
-    -W                         merge-functions=val -- control the operation of the MergeFunctions LLVM pass, taking the same values as the target option of the same name
-    -W                              meta-stats=val -- gather metadata statistics (default: no)
-    -W                          mir-emit-retag=val -- emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0 (default: no)
-    -W                       mir-enable-passes=val -- use like `-Zmir-enable-passes=+DestProp,-InstCombine`. Forces the specified passes to be enabled, overriding all other checks. Passes that are not specified are enabled or disabled by other flags as usual.
-    -W                           mir-opt-level=val -- MIR optimization level (0-4; default: 1 in non optimized builds and 2 in optimized builds)
-    -W                         move-size-limit=val -- the size at which the `large_assignments` lint starts to be emitted
-    -W                         mutable-noalias=val -- emit noalias metadata for mutable references (default: yes)
-    -W                   new-llvm-pass-manager=val -- use new LLVM pass manager (default: no)
-    -W                               nll-facts=val -- dump facts from NLL analysis into side files (default: no)
-    -W                           nll-facts-dir=val -- the directory the NLL facts are dumped into (default: `nll-facts`)
-    -W                             no-analysis=val -- parse and expand the source, but run no analysis
-    -W                              no-codegen=val -- run all passes except codegen; no output
-    -W              no-generate-arange-section=val -- omit DWARF address ranges that give faster lookups
-    -W                     no-interleave-lints=val -- execute lints separately; allows benchmarking individual lints
-    -W                           no-leak-check=val -- disable the 'leak check' for subtyping; unsound, but useful for tests
-    -W                                 no-link=val -- compile without linking
-    -W                        no-parallel-llvm=val -- run LLVM in non-parallel mode (while keeping codegen-units and ThinLTO)
-    -W                 no-unique-section-names=val -- do not use unique names for text and data sections when -Z function-sections is used
-    -W                     no-profiler-runtime=val -- prevent automatic injection of the profiler_builtins crate
-    -W                          normalize-docs=val -- normalize associated items in rustdoc when generating documentation
-    -W                                     oom=val -- panic strategy for out-of-memory handling
-    -W                  osx-rpath-install-name=val -- pass `-install_name @rpath/...` to the macOS linker (default: no)
-    -W                       panic-abort-tests=val -- support compiling tests with panic=abort (default: no)
-    -W                           panic-in-drop=val -- panic strategy for panics in drops
-    -W                              parse-only=val -- parse only; do not compile, assemble, or link (default: no)
-    -W                              perf-stats=val -- print some performance-related statistics (default: no)
-    -W pick-stable-methods-before-any-unstable=val -- try to pick stable methods first before picking any unstable methods (default: yes)
-    -W                                     plt=val -- whether to use the PLT when calling into shared libraries;
-        only has effect for PIC code on systems with ELF binaries
-        (default: PLT is disabled if full relro is enabled)
-    -W                                polonius=val -- enable polonius-based borrow-checker (default: no)
-    -W                            polymorphize=val -- perform polymorphization analysis
-    -W                            pre-link-arg=val -- a single extra argument to prepend the linker invocation (can be used several times)
-    -W                           pre-link-args=val -- extra arguments to prepend to the linker invocation (space separated)
-    -W           precise-enum-drop-elaboration=val -- use a more precise version of drop elaboration for matches on enums (default: yes). This results in better codegen, but has caused miscompilations on some tier 2 platforms. See #77382 and #74551.
-    -W                              print-fuel=val -- make rustc print the total optimization fuel used by a crate
-    -W                       print-llvm-passes=val -- print the LLVM optimization passes being run (default: no)
-    -W                        print-mono-items=val -- print the result of the monomorphization collection pass
-    -W                        print-type-sizes=val -- print layout information for each type encountered (default: no)
-    -W                    proc-macro-backtrace=val -- show backtraces for panics during proc-macro execution (default: no)
-    -W                                 profile=val -- insert profiling code (default: no)
-    -W                        profile-closures=val -- profile size of closures
-    -W                            profile-emit=val -- file path to emit profiling data at runtime when using 'profile' (default based on relative source path)
-    -W                        profiler-runtime=val -- name of the profiler runtime crate to automatically inject (default: `profiler_builtins`)
-    -W                      profile-sample-use=val -- use the given `.prof` file for sampled profile-guided optimization (also known as AutoFDO)
-    -W                         query-dep-graph=val -- enable queries of the dependency graph for regression testing (default: no)
-    -W                        randomize-layout=val -- randomize the layout of types (default: no)
-    -W                             layout-seed=val -- seed layout randomization
-    -W                   relax-elf-relocations=val -- whether ELF relocations can be relaxed
-    -W                             relro-level=val -- choose which RELRO level to use
-    -W                        remap-cwd-prefix=val -- remap paths under the current working directory to this path prefix
-    -W         simulate-remapped-rust-src-base=val -- simulate the effect of remap-debuginfo = true at bootstrapping by remapping path to rust's source base directory. only meant for testing purposes
-    -W                     report-delayed-bugs=val -- immediately print bugs registered with `delay_span_bug` (default: no)
-    -W                               sanitizer=val -- use a sanitizer
-    -W          sanitizer-memory-track-origins=val -- enable origins tracking in MemorySanitizer
-    -W                       sanitizer-recover=val -- enable recovery for selected sanitizers
-    -W                  saturating-float-casts=val -- make float->int casts UB-free: numbers outside the integer type's range are clipped to the max/min integer respectively, and NaN is mapped to 0 (default: yes)
-    -W                           save-analysis=val -- write syntax and type analysis (in JSON format) information, in addition to normal output (default: no)
-    -W                            self-profile=val -- run the self profiler and output the raw event data
-    -W                     self-profile-events=val -- specify the events recorded by the self profiler;
-        for example: `-Z self-profile-events=default,query-keys`
-        all options: none, all, default, generic-activity, query-provider, query-cache-hit
-                     query-blocked, incr-cache-load, incr-result-hashing, query-keys, function-args, args, llvm, artifact-sizes
-    -W                    self-profile-counter=val -- counter used by the self profiler (default: `wall-time`), one of:
-        `wall-time` (monotonic clock, i.e. `std::time::Instant`)
-        `instructions:u` (retired instructions, userspace-only)
-        `instructions-minus-irqs:u` (subtracting hardware interrupt counts for extra accuracy)
-    -W                          share-generics=val -- make the current crate share its generic instantiations
-    -W                               show-span=val -- show spans for compiler debugging (expr|pat|ty)
-    -W                              span-debug=val -- forward proc_macro::Span's `Debug` impl to `Span`
-    -W                       span-free-formats=val -- exclude spans when debug-printing compiler state (default: no)
-    -W                      src-hash-algorithm=val -- hash algorithm of source files in debug info (`md5`, `sha1`, or `sha256`)
-    -W                         stack-protector=val -- control stack smash protection strategy (`rustc --print stack-protector-strategies` for details)
-    -W                      strict-init-checks=val -- control if mem::uninitialized and mem::zeroed panic on more UB
-    -W                                   strip=val -- tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)
-    -W                        split-dwarf-kind=val -- split dwarf variant (only if -Csplit-debuginfo is enabled and on relevant platform)
-        (default: `split`)
-
-        `split`: sections which do not require relocation are written into a DWARF object (`.dwo`)
-                 file which is ignored by the linker
-        `single`: sections which do not require relocation are written into object file but ignored
-                  by the linker
-    -W                    split-dwarf-inlining=val -- provide minimal debug info in the object/executable to facilitate online symbolication/stack traces in the absence of .dwo/.dwp files when using Split DWARF
-    -W                 symbol-mangling-version=val -- which mangling version to use for symbol names ('legacy' (default) or 'v0')
-    -W                                   teach=val -- show extended diagnostic help (default: no)
-    -W                               temps-dir=val -- the directory the intermediate files are written to
-    -W                          terminal-width=val -- set the current terminal width
-    -W                          translate-lang=val -- language identifier for diagnostic output
-    -W                translate-additional-ftl=val -- additional fluent translation to preferentially use (for testing translation)
-    -W        translate-directionality-markers=val -- emit directionality isolation markers in translated diagnostics
-    -W                                tune-cpu=val -- select processor to schedule for (`rustc --print target-cpus` for details)
-    -W                                 thinlto=val -- enable ThinLTO when possible
-    -W                           thir-unsafeck=val -- use the THIR unsafety checker (default: no)
-    -W                                 threads=val -- use a thread pool with N threads
-    -W                                    time=val -- measure time of rustc processes (default: no)
-    -W                        time-llvm-passes=val -- measure time of each LLVM pass (default: no)
-    -W                             time-passes=val -- measure time of each rustc pass (default: no)
-    -W                               tls-model=val -- choose the TLS model to use (`rustc --print tls-models` for details)
-    -W                            trace-macros=val -- for every macro invocation, print its name and arguments (default: no)
-    -W   translate-remapped-path-to-local-path=val -- translate remapped paths into local paths when possible (default: yes)
-    -W                        trap-unreachable=val -- generate trap instructions for unreachable intrinsics (default: use target setting, usually yes)
-    -W                        treat-err-as-bug=val -- treat error number `val` that occurs as bug
-    -W                   trim-diagnostic-paths=val -- in diagnostics, use heuristics to shorten paths referring to items
-    -W                              ui-testing=val -- emit compiler diagnostics in a form suitable for UI testing (default: no)
-    -W            uninit-const-chunk-threshold=val -- allow generating const initializers with mixed init/uninit chunks, and set the maximum number of chunks for which this is allowed (default: 16)
-    -W          unleash-the-miri-inside-of-you=val -- take the brakes off const evaluation. NOTE: this is unsound (default: no)
-    -W                                unpretty=val -- present the input source, unstable (and less-pretty) variants;
-        `normal`, `identified`,
-        `expanded`, `expanded,identified`,
-        `expanded,hygiene` (with internal representations),
-        `ast-tree` (raw AST before expansion),
-        `ast-tree,expanded` (raw AST after expansion),
-        `hir` (the HIR), `hir,identified`,
-        `hir,typed` (HIR with types for each node),
-        `hir-tree` (dump the raw HIR),
-        `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)
-    -W                        unsound-mir-opts=val -- enable unsound and buggy MIR optimizations (default: no)
-    -W                        unstable-options=val -- adds unstable command line options to rustc interface (default: no)
-    -W                       use-ctors-section=val -- use legacy .ctors section for initializers rather than .init_array
-    -W                            validate-mir=val -- validate MIR after each transformation
-    -W                                 verbose=val -- in general, enable more debug printouts (default: no)
-    -W                          verify-llvm-ir=val -- verify LLVM IR (default: no)
-    -W            virtual-function-elimination=val -- enables dead virtual function elimination optimization. Requires `-Clto[=[fat,yes]]`
-    -W                         wasi-exec-model=val -- whether to build a wasi command or reactor
diff --git a/src/test/run-make/issue-88756-opt-help/x.rs b/src/test/run-make/issue-88756-opt-help/x.rs
deleted file mode 100644
index 5df7576133a..00000000000
--- a/src/test/run-make/issue-88756-opt-help/x.rs
+++ /dev/null
@@ -1 +0,0 @@
-// nothing to see here
diff --git a/src/test/rustdoc-ui/issue-83883-describe-lints.rs b/src/test/rustdoc-ui/issue-83883-describe-lints.rs
index a261b782d48..0474d6c143e 100644
--- a/src/test/rustdoc-ui/issue-83883-describe-lints.rs
+++ b/src/test/rustdoc-ui/issue-83883-describe-lints.rs
@@ -1,8 +1,10 @@
 // compile-flags: -W help
 // check-pass
+// check-stdout
+// error-pattern:Lint checks provided
+// error-pattern:rustdoc::broken-intra-doc-links
 //
 // ignore-tidy-linelength
 //
 // normalize-stdout-test: "( +name  default  meaning\n +----  -------  -------\n)?( *[[:word:]:-]+  (allow  |warn   |deny   |forbid )  [^\n]+\n)+" -> "    $$NAMES  $$LEVELS  $$MEANINGS"
 // normalize-stdout-test: " +name  sub-lints\n +----  ---------\n( *[[:word:]:-]+  [^\n]+\n)+" -> "    $$NAMES  $$SUB_LINTS"
-// normalize-stdout-test: " +rustdoc::all(  (rustdoc::[[:word:]-]+, )*rustdoc::[[:word:]-]+)?" -> "    rustdoc::all  $$GROUPS$4"
diff --git a/src/test/rustdoc-ui/issue-83883-describe-lints.stdout b/src/test/rustdoc-ui/issue-83883-describe-lints.stdout
index 5cb7ecb649a..bbf66a31583 100644
--- a/src/test/rustdoc-ui/issue-83883-describe-lints.stdout
+++ b/src/test/rustdoc-ui/issue-83883-describe-lints.stdout
@@ -1,193 +1,24 @@
-    -W                          allow-features=val -- only allow the listed language features to be enabled in code (space separated)
-    -W                       always-encode-mir=val -- encode MIR of all functions into the crate metadata (default: no)
-    -W               assume-incomplete-release=val -- make cfg(version) treat the current version as incomplete (default: no)
-    -W                            asm-comments=val -- generate comments into the assembly (may change behavior) (default: no)
-    -W                       assert-incr-state=val -- assert that the incremental cache is in given state: either `loaded` or `not-loaded`.
-    -W                      binary-dep-depinfo=val -- include artifacts (sysroot, crate dependencies) used during compilation in dep-info (default: no)
-    -W                       branch-protection=val -- set options for branch target identification and pointer authentication on AArch64
-    -W                           cf-protection=val -- instrument control-flow architecture protection
-    -W               cgu-partitioning-strategy=val -- the codegen unit partitioning strategy to use
-    -W                                   chalk=val -- enable the experimental Chalk-based trait solving engine
-    -W                         codegen-backend=val -- the backend to use
-    -W                             combine-cgu=val -- combine CGUs into a single one
-    -W                              crate-attr=val -- inject the given attribute in the crate
-    -W                debug-info-for-profiling=val -- emit discriminators and other data necessary for AutoFDO
-    -W                            debug-macros=val -- emit line numbers debug info inside macros (default: no)
-    -W                 deduplicate-diagnostics=val -- deduplicate identical diagnostics (default: yes)
-    -W                  dep-info-omit-d-target=val -- in dep-info output, omit targets for tracking dependencies of the dep-info files themselves (default: no)
-    -W                               dep-tasks=val -- print tasks that execute and the color their dep node gets (requires debug build) (default: no)
-    -W                                 dlltool=val -- import library generation tool (windows-gnu only)
-    -W                 dont-buffer-diagnostics=val -- emit diagnostics rather than buffering (breaks NLL error downgrading, sorting) (default: no)
-    -W                           drop-tracking=val -- enables drop tracking in generators (default: no)
-    -W                        dual-proc-macros=val -- load proc macros for both target and host, but only link to the target (default: no)
-    -W                          dump-dep-graph=val -- dump the dependency graph to $RUST_DEP_GRAPH (default: /tmp/dep_graph.gv) (default: no)
-    -W                                dump-mir=val -- dump MIR state to file.
-        `val` is used to select which passes and functions to dump. For example:
-        `all` matches all passes and functions,
-        `foo` matches all passes for functions whose name contains 'foo',
-        `foo & ConstProp` only the 'ConstProp' pass for function names containing 'foo',
-        `foo | bar` all passes for function names containing 'foo' or 'bar'.
-    -W                       dump-mir-dataflow=val -- in addition to `.mir` files, create graphviz `.dot` files with dataflow results (default: no)
-    -W                            dump-mir-dir=val -- the directory the MIR is dumped into (default: `mir_dump`)
-    -W            dump-mir-exclude-pass-number=val -- exclude the pass number when dumping MIR (used in tests) (default: no)
-    -W                       dump-mir-graphviz=val -- in addition to `.mir` files, create graphviz `.dot` files (and with `-Z instrument-coverage`, also create a `.dot` file for the MIR-derived coverage graph) (default: no)
-    -W                       dump-mir-spanview=val -- in addition to `.mir` files, create `.html` files to view spans for all `statement`s (including terminators), only `terminator` spans, or computed `block` spans (one span encompassing a block's terminator and all statements). If `-Z instrument-coverage` is also enabled, create an additional `.html` file showing the computed coverage spans.
-    -W                        emit-stack-sizes=val -- emit a section containing stack size metadata (default: no)
-    -W                             fewer-names=val -- reduce memory use by retaining fewer names within compilation artifacts (LLVM-IR) (default: no)
-    -W              force-unstable-if-unmarked=val -- force all crates to be `rustc_private` unstable (default: no)
-    -W                                    fuel=val -- set the optimization fuel quota for a crate
-    -W                       function-sections=val -- whether each function should go in its own section
-    -W                    future-incompat-test=val -- forces all lints to be future incompatible, used for internal testing (default: no)
-    -W                                  gcc-ld=val -- implementation of ld used by cc
-    -W                      graphviz-dark-mode=val -- use dark-themed colors in graphviz output (default: no)
-    -W                           graphviz-font=val -- use the given `fontname` in graphviz output; can be overridden by setting environment variable `RUSTC_GRAPHVIZ_FONT` (default: `Courier, monospace`)
-    -W                               hir-stats=val -- print some statistics about AST and HIR (default: no)
-    -W                human-readable-cgu-names=val -- generate human-readable, predictable names for codegen units (default: no)
-    -W                        identify-regions=val -- display unnamed regions as `'<id>`, using a non-ident unique id (default: no)
-    -W                incremental-ignore-spans=val -- ignore spans during ICH computation -- used for testing (default: no)
-    -W                        incremental-info=val -- print high-level information about incremental reuse (or the lack thereof) (default: no)
-    -W              incremental-relative-spans=val -- hash spans relative to their parent item for incr. comp. (default: no)
-    -W                  incremental-verify-ich=val -- verify incr. comp. hashes of green query instances (default: no)
-    -W                              inline-mir=val -- enable MIR inlining (default: no)
-    -W                    inline-mir-threshold=val -- a default MIR inlining threshold (default: 50)
-    -W               inline-mir-hint-threshold=val -- inlining threshold for functions with inline hint (default: 100)
-    -W                      inline-in-all-cgus=val -- control whether `#[inline]` functions are in all CGUs
-    -W                             input-stats=val -- gather statistics about the input (default: no)
-    -W                     instrument-coverage=val -- instrument the generated code to support LLVM source-based code coverage reports (note, the compiler build config must include `profiler = true`); implies `-C symbol-mangling-version=v0`. Optional values are:
-        `=all` (implicit value)
-        `=except-unused-generics`
-        `=except-unused-functions`
-        `=off` (default)
-    -W                       instrument-mcount=val -- insert function instrument code for mcount-based tracing (default: no)
-    -W                       keep-hygiene-data=val -- keep hygiene data after analysis (default: no)
-    -W                   link-native-libraries=val -- link native libraries in the linker invocation (default: yes)
-    -W                               link-only=val -- link the `.rlink` file generated by `-Z no-link` (default: no)
-    -W                            llvm-plugins=val -- a list LLVM plugins to enable (space separated)
-    -W                         llvm-time-trace=val -- generate JSON tracing data file from LLVM data (default: no)
-    -W                         location-detail=val -- comma separated list of location details to be tracked when using caller_location valid options are `file`, `line`, and `column` (default: all)
-    -W                                      ls=val -- list the symbols defined by a library crate (default: no)
-    -W                         macro-backtrace=val -- show macro backtraces (default: no)
-    -W                         merge-functions=val -- control the operation of the MergeFunctions LLVM pass, taking the same values as the target option of the same name
-    -W                              meta-stats=val -- gather metadata statistics (default: no)
-    -W                          mir-emit-retag=val -- emit Retagging MIR statements, interpreted e.g., by miri; implies -Zmir-opt-level=0 (default: no)
-    -W                       mir-enable-passes=val -- use like `-Zmir-enable-passes=+DestProp,-InstCombine`. Forces the specified passes to be enabled, overriding all other checks. Passes that are not specified are enabled or disabled by other flags as usual.
-    -W                           mir-opt-level=val -- MIR optimization level (0-4; default: 1 in non optimized builds and 2 in optimized builds)
-    -W                         move-size-limit=val -- the size at which the `large_assignments` lint starts to be emitted
-    -W                         mutable-noalias=val -- emit noalias metadata for mutable references (default: yes)
-    -W                   new-llvm-pass-manager=val -- use new LLVM pass manager (default: no)
-    -W                               nll-facts=val -- dump facts from NLL analysis into side files (default: no)
-    -W                           nll-facts-dir=val -- the directory the NLL facts are dumped into (default: `nll-facts`)
-    -W                             no-analysis=val -- parse and expand the source, but run no analysis
-    -W                              no-codegen=val -- run all passes except codegen; no output
-    -W              no-generate-arange-section=val -- omit DWARF address ranges that give faster lookups
-    -W                     no-interleave-lints=val -- execute lints separately; allows benchmarking individual lints
-    -W                           no-leak-check=val -- disable the 'leak check' for subtyping; unsound, but useful for tests
-    -W                                 no-link=val -- compile without linking
-    -W                        no-parallel-llvm=val -- run LLVM in non-parallel mode (while keeping codegen-units and ThinLTO)
-    -W                 no-unique-section-names=val -- do not use unique names for text and data sections when -Z function-sections is used
-    -W                     no-profiler-runtime=val -- prevent automatic injection of the profiler_builtins crate
-    -W                          normalize-docs=val -- normalize associated items in rustdoc when generating documentation
-    -W                                     oom=val -- panic strategy for out-of-memory handling
-    -W                  osx-rpath-install-name=val -- pass `-install_name @rpath/...` to the macOS linker (default: no)
-    -W                       panic-abort-tests=val -- support compiling tests with panic=abort (default: no)
-    -W                           panic-in-drop=val -- panic strategy for panics in drops
-    -W                              parse-only=val -- parse only; do not compile, assemble, or link (default: no)
-    -W                              perf-stats=val -- print some performance-related statistics (default: no)
-    -W pick-stable-methods-before-any-unstable=val -- try to pick stable methods first before picking any unstable methods (default: yes)
-    -W                                     plt=val -- whether to use the PLT when calling into shared libraries;
-        only has effect for PIC code on systems with ELF binaries
-        (default: PLT is disabled if full relro is enabled)
-    -W                                polonius=val -- enable polonius-based borrow-checker (default: no)
-    -W                            polymorphize=val -- perform polymorphization analysis
-    -W                            pre-link-arg=val -- a single extra argument to prepend the linker invocation (can be used several times)
-    -W                           pre-link-args=val -- extra arguments to prepend to the linker invocation (space separated)
-    -W           precise-enum-drop-elaboration=val -- use a more precise version of drop elaboration for matches on enums (default: yes). This results in better codegen, but has caused miscompilations on some tier 2 platforms. See #77382 and #74551.
-    -W                              print-fuel=val -- make rustc print the total optimization fuel used by a crate
-    -W                       print-llvm-passes=val -- print the LLVM optimization passes being run (default: no)
-    -W                        print-mono-items=val -- print the result of the monomorphization collection pass
-    -W                        print-type-sizes=val -- print layout information for each type encountered (default: no)
-    -W                    proc-macro-backtrace=val -- show backtraces for panics during proc-macro execution (default: no)
-    -W                                 profile=val -- insert profiling code (default: no)
-    -W                        profile-closures=val -- profile size of closures
-    -W                            profile-emit=val -- file path to emit profiling data at runtime when using 'profile' (default based on relative source path)
-    -W                        profiler-runtime=val -- name of the profiler runtime crate to automatically inject (default: `profiler_builtins`)
-    -W                      profile-sample-use=val -- use the given `.prof` file for sampled profile-guided optimization (also known as AutoFDO)
-    -W                         query-dep-graph=val -- enable queries of the dependency graph for regression testing (default: no)
-    -W                        randomize-layout=val -- randomize the layout of types (default: no)
-    -W                             layout-seed=val -- seed layout randomization
-    -W                   relax-elf-relocations=val -- whether ELF relocations can be relaxed
-    -W                             relro-level=val -- choose which RELRO level to use
-    -W                        remap-cwd-prefix=val -- remap paths under the current working directory to this path prefix
-    -W         simulate-remapped-rust-src-base=val -- simulate the effect of remap-debuginfo = true at bootstrapping by remapping path to rust's source base directory. only meant for testing purposes
-    -W                     report-delayed-bugs=val -- immediately print bugs registered with `delay_span_bug` (default: no)
-    -W                               sanitizer=val -- use a sanitizer
-    -W          sanitizer-memory-track-origins=val -- enable origins tracking in MemorySanitizer
-    -W                       sanitizer-recover=val -- enable recovery for selected sanitizers
-    -W                  saturating-float-casts=val -- make float->int casts UB-free: numbers outside the integer type's range are clipped to the max/min integer respectively, and NaN is mapped to 0 (default: yes)
-    -W                           save-analysis=val -- write syntax and type analysis (in JSON format) information, in addition to normal output (default: no)
-    -W                            self-profile=val -- run the self profiler and output the raw event data
-    -W                     self-profile-events=val -- specify the events recorded by the self profiler;
-        for example: `-Z self-profile-events=default,query-keys`
-        all options: none, all, default, generic-activity, query-provider, query-cache-hit
-                     query-blocked, incr-cache-load, incr-result-hashing, query-keys, function-args, args, llvm, artifact-sizes
-    -W                    self-profile-counter=val -- counter used by the self profiler (default: `wall-time`), one of:
-        `wall-time` (monotonic clock, i.e. `std::time::Instant`)
-        `instructions:u` (retired instructions, userspace-only)
-        `instructions-minus-irqs:u` (subtracting hardware interrupt counts for extra accuracy)
-    -W                          share-generics=val -- make the current crate share its generic instantiations
-    -W                               show-span=val -- show spans for compiler debugging (expr|pat|ty)
-    -W                              span-debug=val -- forward proc_macro::Span's `Debug` impl to `Span`
-    -W                       span-free-formats=val -- exclude spans when debug-printing compiler state (default: no)
-    -W                      src-hash-algorithm=val -- hash algorithm of source files in debug info (`md5`, `sha1`, or `sha256`)
-    -W                         stack-protector=val -- control stack smash protection strategy (`rustc --print stack-protector-strategies` for details)
-    -W                      strict-init-checks=val -- control if mem::uninitialized and mem::zeroed panic on more UB
-    -W                                   strip=val -- tell the linker which information to strip (`none` (default), `debuginfo` or `symbols`)
-    -W                        split-dwarf-kind=val -- split dwarf variant (only if -Csplit-debuginfo is enabled and on relevant platform)
-        (default: `split`)
 
-        `split`: sections which do not require relocation are written into a DWARF object (`.dwo`)
-                 file which is ignored by the linker
-        `single`: sections which do not require relocation are written into object file but ignored
-                  by the linker
-    -W                    split-dwarf-inlining=val -- provide minimal debug info in the object/executable to facilitate online symbolication/stack traces in the absence of .dwo/.dwp files when using Split DWARF
-    -W                 symbol-mangling-version=val -- which mangling version to use for symbol names ('legacy' (default) or 'v0')
-    -W                                   teach=val -- show extended diagnostic help (default: no)
-    -W                               temps-dir=val -- the directory the intermediate files are written to
-    -W                          terminal-width=val -- set the current terminal width
-    -W                          translate-lang=val -- language identifier for diagnostic output
-    -W                translate-additional-ftl=val -- additional fluent translation to preferentially use (for testing translation)
-    -W        translate-directionality-markers=val -- emit directionality isolation markers in translated diagnostics
-    -W                                tune-cpu=val -- select processor to schedule for (`rustc --print target-cpus` for details)
-    -W                                 thinlto=val -- enable ThinLTO when possible
-    -W                           thir-unsafeck=val -- use the THIR unsafety checker (default: no)
-    -W                                 threads=val -- use a thread pool with N threads
-    -W                                    time=val -- measure time of rustc processes (default: no)
-    -W                        time-llvm-passes=val -- measure time of each LLVM pass (default: no)
-    -W                             time-passes=val -- measure time of each rustc pass (default: no)
-    -W                               tls-model=val -- choose the TLS model to use (`rustc --print tls-models` for details)
-    -W                            trace-macros=val -- for every macro invocation, print its name and arguments (default: no)
-    -W   translate-remapped-path-to-local-path=val -- translate remapped paths into local paths when possible (default: yes)
-    -W                        trap-unreachable=val -- generate trap instructions for unreachable intrinsics (default: use target setting, usually yes)
-    -W                        treat-err-as-bug=val -- treat error number `val` that occurs as bug
-    -W                   trim-diagnostic-paths=val -- in diagnostics, use heuristics to shorten paths referring to items
-    -W                              ui-testing=val -- emit compiler diagnostics in a form suitable for UI testing (default: no)
-    -W            uninit-const-chunk-threshold=val -- allow generating const initializers with mixed init/uninit chunks, and set the maximum number of chunks for which this is allowed (default: 16)
-    -W          unleash-the-miri-inside-of-you=val -- take the brakes off const evaluation. NOTE: this is unsound (default: no)
-    -W                                unpretty=val -- present the input source, unstable (and less-pretty) variants;
-        `normal`, `identified`,
-        `expanded`, `expanded,identified`,
-        `expanded,hygiene` (with internal representations),
-        `ast-tree` (raw AST before expansion),
-        `ast-tree,expanded` (raw AST after expansion),
-        `hir` (the HIR), `hir,identified`,
-        `hir,typed` (HIR with types for each node),
-        `hir-tree` (dump the raw HIR),
-        `mir` (the MIR), or `mir-cfg` (graphviz formatted MIR)
-    -W                        unsound-mir-opts=val -- enable unsound and buggy MIR optimizations (default: no)
-    -W                        unstable-options=val -- adds unstable command line options to rustc interface (default: no)
-    -W                       use-ctors-section=val -- use legacy .ctors section for initializers rather than .init_array
-    -W                            validate-mir=val -- validate MIR after each transformation
-    -W                                 verbose=val -- in general, enable more debug printouts (default: no)
-    -W                          verify-llvm-ir=val -- verify LLVM IR (default: no)
-    -W            virtual-function-elimination=val -- enables dead virtual function elimination optimization. Requires `-Clto[=[fat,yes]]`
-    -W                         wasi-exec-model=val -- whether to build a wasi command or reactor
+Available lint options:
+    -W <foo>           Warn about <foo>
+    -A <foo>           Allow <foo>
+    -D <foo>           Deny <foo>
+    -F <foo>           Forbid <foo> (deny <foo> and all attempts to override)
+
+
+Lint checks provided by rustc:
+
+    $NAMES  $LEVELS  $MEANINGS
+
+Lint groups provided by rustc:
+
+    $NAMES  $SUB_LINTS
+
+Lint checks provided by plugins loaded by this crate:
+
+    $NAMES  $LEVELS  $MEANINGS
+
+Lint groups provided by plugins loaded by this crate:
+
+    $NAMES  $SUB_LINTS
+
diff --git a/src/tools/compiletest/src/runtest.rs b/src/tools/compiletest/src/runtest.rs
index 160b9785d97..075d75a1d6c 100644
--- a/src/tools/compiletest/src/runtest.rs
+++ b/src/tools/compiletest/src/runtest.rs
@@ -3245,7 +3245,8 @@ impl<'test> TestCx<'test> {
 
             if !self.props.error_patterns.is_empty() {
                 // "// error-pattern" comments
-                self.check_error_patterns(&proc_res.stderr, &proc_res, pm);
+                let output_to_check = self.get_output(&proc_res);
+                self.check_error_patterns(&output_to_check, &proc_res, pm);
             }
         }
 
@@ -3266,7 +3267,8 @@ impl<'test> TestCx<'test> {
 
             if check_patterns {
                 // "// error-pattern" comments
-                self.check_error_patterns(&proc_res.stderr, &proc_res, pm);
+                let output_to_check = self.get_output(&proc_res);
+                self.check_error_patterns(&output_to_check, &proc_res, pm);
             }
 
             if check_annotations {

From e710ac12fac9d650fb53b27259332cabdc9416f5 Mon Sep 17 00:00:00 2001
From: Michael Howell <michael@notriddle.com>
Date: Sat, 2 Jul 2022 09:42:49 -0700
Subject: [PATCH 07/10] rustdoc: add test case for source sidebar spacing

---
 src/test/rustdoc-gui/source-code-page.goml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/test/rustdoc-gui/source-code-page.goml b/src/test/rustdoc-gui/source-code-page.goml
index 05b0e809bca..581f826a3d9 100644
--- a/src/test/rustdoc-gui/source-code-page.goml
+++ b/src/test/rustdoc-gui/source-code-page.goml
@@ -44,3 +44,6 @@ assert-property: ("#source-sidebar details:first-of-type", {"open": "true"})
 // And now we collapse it again.
 click: "#source-sidebar details:first-of-type > summary"
 assert-property: ("#source-sidebar details:first-of-type", {"open": "false"})
+
+// Check the spacing.
+assert-css: ("#source-sidebar > details.dir-entry", {"padding-left": "4px"})

From dbe77e856ad5cf6298de19ce5c2730f2f631b4ef Mon Sep 17 00:00:00 2001
From: InfRandomness <infrandomness@gmail.com>
Date: Sun, 5 Jun 2022 23:33:39 +0200
Subject: [PATCH 08/10] Add miri to the rustc docs.rs page

This adds miri to https://doc.rust-lang.org/nightly/nightly-rustc/

Signed-off-by: InfRandomness <infrandomness@gmail.com>
---
 src/bootstrap/builder.rs | 1 +
 src/bootstrap/doc.rs     | 1 +
 2 files changed, 2 insertions(+)

diff --git a/src/bootstrap/builder.rs b/src/bootstrap/builder.rs
index 755c532ab32..fa2a530d9db 100644
--- a/src/bootstrap/builder.rs
+++ b/src/bootstrap/builder.rs
@@ -694,6 +694,7 @@ impl<'a> Builder<'a> {
                 doc::RustcBook,
                 doc::CargoBook,
                 doc::Clippy,
+                doc::Miri,
                 doc::EmbeddedBook,
                 doc::EditionGuide,
             ),
diff --git a/src/bootstrap/doc.rs b/src/bootstrap/doc.rs
index be6655ddb61..31eda2dc984 100644
--- a/src/bootstrap/doc.rs
+++ b/src/bootstrap/doc.rs
@@ -737,6 +737,7 @@ tool_doc!(
     ["rustfmt-nightly", "rustfmt-config_proc_macro"],
 );
 tool_doc!(Clippy, "clippy", "src/tools/clippy", ["clippy_utils"]);
+tool_doc!(Miri, "miri", "src/tools/miri", ["miri"]);
 
 #[derive(Ord, PartialOrd, Debug, Copy, Clone, Hash, PartialEq, Eq)]
 pub struct ErrorIndex {

From 45a69cc215c05bfc283564c9898e9c3704de8c80 Mon Sep 17 00:00:00 2001
From: InfRandomness <infrandomness@gmail.com>
Date: Mon, 6 Jun 2022 17:21:39 +0200
Subject: [PATCH 09/10] Add in_tree macro literal

Signed-off-by: InfRandomness <infrandomness@gmail.com>
---
 src/bootstrap/doc.rs | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/src/bootstrap/doc.rs b/src/bootstrap/doc.rs
index 31eda2dc984..eb29a5e9ffc 100644
--- a/src/bootstrap/doc.rs
+++ b/src/bootstrap/doc.rs
@@ -643,7 +643,7 @@ impl Step for Rustc {
 }
 
 macro_rules! tool_doc {
-    ($tool: ident, $should_run: literal, $path: literal, [$($krate: literal),+ $(,)?] $(,)?) => {
+    ($tool: ident, $should_run: literal, $path: literal, [$($krate: literal),+ $(,)?], in_tree = $in_tree:expr $(,)?) => {
         #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
         pub struct $tool {
             target: TargetSelection,
@@ -699,6 +699,12 @@ macro_rules! tool_doc {
                 t!(fs::create_dir_all(&out_dir));
                 t!(symlink_dir_force(&builder.config, &out, &out_dir));
 
+                let source_type = if $in_tree == true {
+                    SourceType::InTree
+                } else {
+                    SourceType::Submodule
+                };
+
                 // Build cargo command.
                 let mut cargo = prepare_tool_cargo(
                     builder,
@@ -707,7 +713,7 @@ macro_rules! tool_doc {
                     target,
                     "doc",
                     $path,
-                    SourceType::InTree,
+                    source_type,
                     &[],
                 );
 
@@ -729,15 +735,22 @@ macro_rules! tool_doc {
     }
 }
 
-tool_doc!(Rustdoc, "rustdoc-tool", "src/tools/rustdoc", ["rustdoc", "rustdoc-json-types"]);
+tool_doc!(
+    Rustdoc,
+    "rustdoc-tool",
+    "src/tools/rustdoc",
+    ["rustdoc", "rustdoc-json-types"],
+    in_tree = true
+);
 tool_doc!(
     Rustfmt,
     "rustfmt-nightly",
     "src/tools/rustfmt",
     ["rustfmt-nightly", "rustfmt-config_proc_macro"],
+    in_tree = true
 );
-tool_doc!(Clippy, "clippy", "src/tools/clippy", ["clippy_utils"]);
-tool_doc!(Miri, "miri", "src/tools/miri", ["miri"]);
+tool_doc!(Clippy, "clippy", "src/tools/clippy", ["clippy_utils"], in_tree = true);
+tool_doc!(Miri, "miri", "src/tools/miri", ["miri"], in_tree = false);
 
 #[derive(Ord, PartialOrd, Debug, Copy, Clone, Hash, PartialEq, Eq)]
 pub struct ErrorIndex {

From ed92d88ff4c71e2ae02511c040f0e2a88e57a262 Mon Sep 17 00:00:00 2001
From: Ralf Jung <post@ralfj.de>
Date: Thu, 30 Jun 2022 10:41:04 -0400
Subject: [PATCH 10/10] ignore rustdoc failures for out-of-tree tools

---
 src/bootstrap/doc.rs | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/bootstrap/doc.rs b/src/bootstrap/doc.rs
index eb29a5e9ffc..3cf0f9b9f99 100644
--- a/src/bootstrap/doc.rs
+++ b/src/bootstrap/doc.rs
@@ -729,7 +729,17 @@ macro_rules! tool_doc {
                 cargo.rustdocflag("--show-type-layout");
                 cargo.rustdocflag("--generate-link-to-definition");
                 cargo.rustdocflag("-Zunstable-options");
-                builder.run(&mut cargo.into());
+                if $in_tree == true {
+                    builder.run(&mut cargo.into());
+                } else {
+                    // Allow out-of-tree docs to fail (since the tool might be in a broken state).
+                    if !builder.try_run(&mut cargo.into()) {
+                        builder.info(&format!(
+                            "WARNING: tool {} failed to document; ignoring failure because it is an out-of-tree tool",
+                            stringify!($tool).to_lowercase(),
+                        ));
+                    }
+                }
             }
         }
     }