mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix outdated doc comment on Releases doc build step

Browse Source
This commit is contained in:
Michael Howell 2023-11-19 08:01:17 -07:00
parent a3d90036c5
commit 0bf77206ad
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/bootstrap/src/core/build_steps/doc.rs
View File

@ -411,14 +411,11 @@ fn make_run(run: RunConfig<'_>) {
});
}
/// 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;