Skip to content

pass --lib to x doc - #112211

Merged
bors merged 1 commit into
rust-lang:masterfrom
eval-exec:exec/fix-bootstrap-rustdoc
Jun 3, 2023
Merged

pass --lib to x doc#112211
bors merged 1 commit into
rust-lang:masterfrom
eval-exec:exec/fix-bootstrap-rustdoc

Conversation

@eval-exec

@eval-execeval-exec commented Jun 2, 2023

Copy link
Copy Markdown
Contributor

This PR want to close#112082

@rustbot

rustbot commented Jun 2, 2023

Copy link
Copy Markdown
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @ozkanonur (or someone else) soon.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@rustbotrustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Jun 2, 2023
onur-ozkan
onur-ozkan suggested changes Jun 2, 2023
View reviewed changes

@onur-ozkanonur-ozkan left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the fix.

Can you update the following as well?

rust/src/bootstrap/builder.rs

Line 1576 in 0939ec1

// src/bootstrap/bin/{rustc.rs,rustdoc.rs}

@onur-ozkan

onur-ozkan commented Jun 2, 2023

Copy link
Copy Markdown
Contributor

@rustbot author

@rustbotrustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 2, 2023
@eval-exec
eval-execforce-pushed the exec/fix-bootstrap-rustdoc branch from 0373f55 to a07b250CompareJune 2, 2023 16:38
@eval-exec

eval-exec commented Jun 2, 2023•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

r? @jyn514@ozkanonur

@jyn514@ozkanonur Request for your review 💟

@rustbot review

@rustbotrustbot assigned jyn514 and unassigned onur-ozkanJun 2, 2023
@rustbotrustbot removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Jun 2, 2023
@eval-exec
eval-exec marked this pull request as ready for review June 2, 2023 16:40
@rustbotrustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 2, 2023
@jyn514

jyn514 commented Jun 2, 2023

Copy link
Copy Markdown
Member

I'm short on time for reviews, please don't assign me.

@jyn514jyn514 assigned onur-ozkan and unassigned jyn514Jun 2, 2023
@eval-exec

eval-exec commented Jun 2, 2023

Copy link
Copy Markdown
ContributorAuthor

Question: How can I build this page on my localhost? I want to view these crates doc on my branch.

@jyn514

jyn514 commented Jun 2, 2023

Copy link
Copy Markdown
Member

@eval-exec try x doc --stage 0 bootstrap rustdoc

@onur-ozkan

onur-ozkan commented Jun 2, 2023

Copy link
Copy Markdown
Contributor

r? @jyn514@ozkanonur

@jyn514@ozkanonur Request for your review heart_decoration

@rustbot review

jfyi: In most cases, we do not reassign the reviewer unless there is a specific reason to do so :)

onur-ozkan
onur-ozkan reviewed Jun 2, 2023
View reviewed changes
Comment threadsrc/bootstrap/Cargo.toml Outdated
@eval-exec
eval-execforce-pushed the exec/fix-bootstrap-rustdoc branch 2 times, most recently from 927d5e6 to 57287aeCompareJune 2, 2023 17:39
@onur-ozkan

onur-ozkan commented Jun 2, 2023

Copy link
Copy Markdown
Contributor

If things goes more complicated than we expected, we can implement the first solution which was pass --lib to cargo so it doesn't try to document the binaries

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@eval-exec

eval-exec commented Jun 2, 2023•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

If things goes more complicated than we expected, we can implement the first solution which was pass --lib to cargo so it doesn't try to document the binaries

It's hard, rustdoc's doc is still as same as rustdoc-shim
image
image

I'd like to pass --lib to cargo. 😭

@onur-ozkan

onur-ozkan commented Jun 2, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

It's hard, rustdoc's doc is still as same as rustdoc-shim

It's probably because you didn't build rustdoc again after updating binary name. So this was from the previous build. Regenerate the docs after x clean, then it should do the job.

--

I'd like to pass --lib to cargo.

Yes please. Updating the binary name requires updating so many different spots in bootstrapping, which will fail the CI until we replace all of them correctly. So it's better to simply implement the first idea.

@eval-exec
eval-execforce-pushed the exec/fix-bootstrap-rustdoc branch from 57287ae to 8657a64CompareJune 2, 2023 17:59
@eval-exec

eval-exec commented Jun 2, 2023

Copy link
Copy Markdown
ContributorAuthor

./x doc is slow on my machine, I'm going to sleep and continue this PR 7 hours later.

@onur-ozkanonur-ozkan changed the title Rename bootstrap/bin/rustdoc.rs to bootstrap/bin/rustdoc-shim.rspass --lib to x docJun 2, 2023
@onur-ozkan

onur-ozkan commented Jun 2, 2023

Copy link
Copy Markdown
Contributor

./x doc is slow on my machine, I'm going to sleep and continue this PR 7 hours later.

No worries, I tested it and it works well :)

@bors r+ rollup

@bors

bors commented Jun 2, 2023

Copy link
Copy Markdown
Collaborator

📌 Commit 8657a64 has been approved by ozkanonur

It is now in the queue for this repository.

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 2, 2023
@compiler-errorscompiler-errors mentioned this pull request Jun 2, 2023
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 2, 2023
@bors
Auto merge ofrust-lang#112228- compiler-errors:rollup-97i0pli, r=co…
7a0070e
…mpiler-errors
Rollup of 6 pull requests
Successful merges:
- rust-lang#109609 (Separate AnonConst from ConstBlock in HIR.)
- rust-lang#112166 (bootstrap: Rename profile = user to profile = dist)
- rust-lang#112168 (Lower `unchecked_div`/`_rem` to MIR's `BinOp::Div`/`Rem`)
- rust-lang#112183 (Normalize anon consts in new solver)
- rust-lang#112211 (pass `--lib` to `x doc`)
- rust-lang#112223 (Don't ICE in new solver when auto traits have associated types)
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 163ce68 into rust-lang:masterJun 3, 2023
@rustbotrustbot added this to the 1.72.0 milestone Jun 3, 2023
@eval-exec
eval-exec deleted the exec/fix-bootstrap-rustdoc branch June 3, 2023 02:37
jyn514
jyn514 reviewed Jun 3, 2023
View reviewed changes
Comment threadsrc/bootstrap/doc.rs
cargo.arg("-Zskip-rustdoc-fingerprint");
// Only include compiler crates, no dependencies of those, such as `libc`.
cargo.arg("--no-deps");
cargo.arg("--lib");

@jyn514jyn514Jun 3, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is passed for all tools, not just bootstrap. was that intentional?

@onur-ozkanonur-ozkanJun 3, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, missed it. Thanks for catching, will fix it.

@eval-execeval-execJun 3, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry, I made a mistake. Thank you for your correction.

@onur-ozkanonur-ozkan mentioned this pull request Jun 3, 2023
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 4, 2023
@matthiaskrgr
Rollup merge ofrust-lang#112234- ozkanonur:hotfix, r=albertlarsan68
b0b7b1e
extend `tool_doc!` with `only_libs` arg
resolvesrust-lang#112211 (comment)
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 29, 2023
@matthiaskrgr
Rollup merge ofrust-lang#112234- ozkanonur:hotfix, r=jyn514
93a97c7
refactor `tool_doc!`
resolvesrust-lang#112211 (comment)
compiler-errors added a commit to compiler-errors/rust that referenced this pull request Jun 30, 2023
@compiler-errors
Rollup merge ofrust-lang#112234- ozkanonur:hotfix, r=jyn514
12d4f08
refactor `tool_doc!`
resolvesrust-lang#112211 (comment)
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@jyn514jyn514jyn514 left review comments
@onur-ozkanonur-ozkanonur-ozkan requested changes
Reviewers whose approvals may not affect merge requirements

Assignees

@onur-ozkanonur-ozkan

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.T-bootstrapRelevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)

Projects

None yet

Milestone

1.72.0

Development

Successfully merging this pull request may close these issues.

the docs of rustdoc get overwritten by the bootstrap docs

6 participants

@eval-exec@rustbot@onur-ozkan@jyn514@rust-log-analyzer@bors