Skip to content

Commit 0bf7720

Browse files
committed
Fix outdated doc comment on Releases doc build step
1 parent a3d9003 commit 0bf7720

File tree

1 file changed

+4
-7
lines changed
  • src/bootstrap/src/core/build_steps

1 file changed

+4
-7
lines changed

src/bootstrap/src/core/build_steps/doc.rs

+4-7
Original file line numberDiff line numberDiff line change
@@ -411,14 +411,11 @@ impl Step for Releases {
411411
});
412412
}
413413

414-
/// Generates all standalone documentation as compiled by the rustdoc in `stage`
415-
/// for the `target` into `out`.
414+
/// Generates HTML release notes to include in the final docs bundle.
416415
///
417-
/// This will list all of `src/doc` looking for markdown files and appropriately
418-
/// perform transformations like substituting `VERSION`, `SHORT_HASH`, and
419-
/// `STAMP` along with providing the various header/footer HTML we've customized.
420-
///
421-
/// In the end, this is just a glorified wrapper around rustdoc!
416+
/// This uses the same stylesheet and other tools as Standalone, but the
417+
/// RELEASES.md file is included at the root of the repository and gets
418+
/// the headline added. In the end, the conversion is done by Rustdoc.
422419
fn run(self, builder: &Builder<'_>) {
423420
let target = self.target;
424421
let compiler = self.compiler;

0 commit comments

Comments
 (0)