diff options
| author | Michael Howell <michael@notriddle.com> | 2023-11-19 08:01:17 -0700 |
|---|---|---|
| committer | Michael Howell <michael@notriddle.com> | 2023-11-19 08:01:17 -0700 |
| commit | 0bf77206ad8fc72cc5970ced6a2126b07afbddb0 (patch) | |
| tree | bb871da7fb3d43a20f1d6b2ab1461b687340f7dd | |
| parent | a3d90036c5d3f25fd08a0517a63b28eed5365dd0 (diff) | |
| download | rust-0bf77206ad8fc72cc5970ced6a2126b07afbddb0.tar.gz rust-0bf77206ad8fc72cc5970ced6a2126b07afbddb0.zip | |
Fix outdated doc comment on Releases doc build step
| -rw-r--r-- | src/bootstrap/src/core/build_steps/doc.rs | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/src/bootstrap/src/core/build_steps/doc.rs b/src/bootstrap/src/core/build_steps/doc.rs index 0f960ab4965..834f88dc891 100644 --- a/src/bootstrap/src/core/build_steps/doc.rs +++ b/src/bootstrap/src/core/build_steps/doc.rs @@ -411,14 +411,11 @@ impl Step for Releases { }); } - /// Generates all standalone documentation as compiled by the rustdoc in `stage` - /// for the `target` into `out`. + /// Generates HTML release notes to include in the final docs bundle. /// - /// This will list all of `src/doc` looking for markdown files and appropriately - /// perform transformations like substituting `VERSION`, `SHORT_HASH`, and - /// `STAMP` along with providing the various header/footer HTML we've customized. - /// - /// In the end, this is just a glorified wrapper around rustdoc! + /// This uses the same stylesheet and other tools as Standalone, but the + /// RELEASES.md file is included at the root of the repository and gets + /// the headline added. In the end, the conversion is done by Rustdoc. fn run(self, builder: &Builder<'_>) { let target = self.target; let compiler = self.compiler; |
