Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
fmease opened this issue May 29, 2023 · 3 comments · Fixed by #112211
Closed

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

fmease opened this issue May 29, 2023 · 3 comments · Fixed by #112211
Assignees
@eval-exec
Labels
A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Comments

@fmease
Copy link
Member

fmease commented May 29, 2023 •
edited by rustbot
Loading

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
@rustbot rustbot added A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels May 29, 2023
@jyn514
Copy link
Member

jyn514 commented May 29, 2023

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.

@jyn514
Copy link
Member

jyn514 commented May 29, 2023

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

@jyn514 jyn514 added E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. labels May 31, 2023
@eval-exec eval-exec mentioned this issue Jun 2, 2023
Merged
@eval-exec
Copy link
Contributor

@rustbot claim

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

@eval-exec eval-exec

Labels
A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

pass --lib to x doc eval-exec/rust
4 participants
@fmease @jyn514 @eval-exec @rustbot