Skip to content

Commit

Permalink
Fix outdated doc comment on Releases doc build step
Browse files Browse the repository at this point in the history
  • Loading branch information
notriddle committed Nov 19, 2023
1 parent a3d9003 commit 0bf7720
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions src/bootstrap/src/core/build_steps/doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 0bf7720

Please sign in to comment.