Skip to content

the docs of rustdoc get overwritten by the bootstrap docs #112082

Closed
#112211
Closed
the docs of rustdoc get overwritten by the bootstrap docs#112082
#112211
Assignees
eval-exec
Labels
A-contributor-roadblockArea: Makes things more difficult for new or seasoned contributors to RustA-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Description

@fmease
fmease
opened on May 29, 2023

Since #111976, bootstrap itself gets documented. Unfortunately, the package contains a binary crate called rustdoc (src/bootstrap/bin/rustdoc.rs, Shim which is passed to Cargo as “rustdoc” when running the bootstrap.) which clashes with the actual rustdoc package (src/librustdoc) overwriting the latter since it gets documented last.

See for yourself: https://doc.rust-lang.org/nightly/nightly-rustc/rustdoc/index.html (this ain't rustdoc).

CC @jyn514 (#111976).

@rustbot label C-bug T-bootstrap A-docs A-contributor-roadblock

Activity

  1. rustbot
    added
    A-contributor-roadblockArea: Makes things more difficult for new or seasoned contributors to Rust
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    C-bugCategory: This is a bug.
    T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
    on May 29, 2023

  2. jyn514 commented on May 29, 2023

    @jyn514
    jyn514
    on May 29, 2023
    Member

    ah, thanks! I think the fix is to pass --lib to cargo so it doesn't try to document the binaries, they don't have anything useful.

  3. jyn514 commented on May 29, 2023

    @jyn514
    jyn514
    on May 29, 2023
    Member

    Alternatively - maybe better? - we could rename rustdoc.rs to rustdoc-shim.rs, which seems more clear anyway.

  4. jyn514
    added
    E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
    E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
    on May 31, 2023

  5. eval-exec commented on Jun 2, 2023

    @eval-exec
    eval-exec
    on Jun 2, 2023
    Contributor

    @rustbot claim

  6. rustbot
    assigned
    eval-exec
    on Jun 2, 2023
  7. compiler-errors
    added a commit that references this issue on Jun 2, 2023

    Rollup merge of rust-lang#112211 - eval-exec:exec/fix-bootstrap-rustd…

    163ce68
  8. bors
    closed this as completedin 163ce68on Jun 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

A-contributor-roadblockArea: Makes things more difficult for new or seasoned contributors to RustA-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.E-easyCall for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.E-mentorCall for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions