Skip to content

incorrect comment in bootstrap: stage 1 rustdoc *can* be used #142745

Open
@lolbinarycat

Description

@lolbinarycat

The comment says that only stage 0 or stage 2 rustdoc is used, but the user can simply request stage 1 rustdoc.

#[derive(Debug, Clone, Hash, PartialEq, Eq, Ord, PartialOrd)]
pub struct Rustdoc {
/// This should only ever be 0 or 2.
/// We sometimes want to reference the "bootstrap" rustdoc, which is why this option is here.
pub compiler: Compiler,
}

tested by putting assert_ne!(self.compiler.stage, 1) in Rustdoc::run, then running ./x doc --stage 1 library/core, which causes the added assertion to fail.

Metadata

Metadata

Assignees

No one assigned

    Labels

    T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)needs-triageThis issue may need triage. Remove it if it has been sufficiently triaged.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions