pass `--lib` to `x doc` #112211

eval-exec · 2023-06-02T15:41:49Z

This PR want to close #112082

rustbot · 2023-06-02T15:41:57Z

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

onur-ozkan

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 · 2023-06-02T15:57:33Z

@rustbot author

eval-exec · 2023-06-02T16:40:09Z

r? @jyn514 @ozkanonur

@jyn514 @ozkanonur Request for your review 💟

@rustbot review

jyn514 · 2023-06-02T16:54:12Z

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

eval-exec · 2023-06-02T17:00:13Z

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

jyn514 · 2023-06-02T17:01:05Z

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

onur-ozkan · 2023-06-02T17:02:04Z

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 :)

src/bootstrap/Cargo.toml

onur-ozkan · 2023-06-02T17:40:50Z

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

eval-exec · 2023-06-02T17:45:11Z

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

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

onur-ozkan · 2023-06-02T17:48:04Z

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 · 2023-06-02T18:02:51Z

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

onur-ozkan · 2023-06-02T18:38:27Z

./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 · 2023-06-02T18:38:29Z

📌 Commit 8657a64 has been approved by ozkanonur

It is now in the queue for this repository.

…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

jyn514 · 2023-06-03T04:14:10Z

src/bootstrap/doc.rs

@@ -834,6 +834,7 @@ macro_rules! tool_doc {
                cargo.arg("-Zskip-rustdoc-fingerprint");
                // Only include compiler crates, no dependencies of those, such as `libc`.
                cargo.arg("--no-deps");
+                cargo.arg("--lib");


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

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

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

extend `tool_doc!` with `only_libs` arg resolves rust-lang#112211 (comment)

refactor `tool_doc!` resolves rust-lang#112211 (comment)

rustbot assigned onur-ozkan Jun 2, 2023

rustbot 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 requested changes Jun 2, 2023

View reviewed changes

rustbot 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 force-pushed the exec/fix-bootstrap-rustdoc branch from 0373f55 to a07b250 Compare June 2, 2023 16:38

rustbot assigned jyn514 and unassigned onur-ozkan Jun 2, 2023

rustbot 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 marked this pull request as ready for review June 2, 2023 16:40

rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 2, 2023

jyn514 assigned onur-ozkan and unassigned jyn514 Jun 2, 2023

onur-ozkan reviewed Jun 2, 2023

View reviewed changes

src/bootstrap/Cargo.toml Outdated Show resolved Hide resolved

eval-exec force-pushed the exec/fix-bootstrap-rustdoc branch 2 times, most recently from 927d5e6 to 57287ae Compare June 2, 2023 17:39

This comment has been minimized.

Sign in to view

Add --lib to cargo doc

8657a64

eval-exec force-pushed the exec/fix-bootstrap-rustdoc branch from 57287ae to 8657a64 Compare June 2, 2023 17:59

onur-ozkan changed the title ~~Rename bootstrap/bin/rustdoc.rs to bootstrap/bin/rustdoc-shim.rs~~ pass --lib to x doc Jun 2, 2023

bors 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-errors mentioned this pull request Jun 2, 2023

Rollup of 6 pull requests #112228

Merged

bors merged commit 163ce68 into rust-lang:master Jun 3, 2023

rustbot added this to the 1.72.0 milestone Jun 3, 2023

eval-exec deleted the exec/fix-bootstrap-rustdoc branch June 3, 2023 02:37

jyn514 reviewed Jun 3, 2023

View reviewed changes

onur-ozkan mentioned this pull request Jun 3, 2023

refactor tool_doc! #112234

Merged

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 4, 2023

Rollup merge of rust-lang#112234 - ozkanonur:hotfix, r=albertlarsan68

b0b7b1e

extend `tool_doc!` with `only_libs` arg resolves rust-lang#112211 (comment)

matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Jun 29, 2023

Rollup merge of rust-lang#112234 - ozkanonur:hotfix, r=jyn514

93a97c7

refactor `tool_doc!` resolves rust-lang#112211 (comment)

compiler-errors added a commit to compiler-errors/rust that referenced this pull request Jun 30, 2023

Rollup merge of rust-lang#112234 - ozkanonur:hotfix, r=jyn514

12d4f08

refactor `tool_doc!` resolves rust-lang#112211 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

pass `--lib` to `x doc` #112211

pass `--lib` to `x doc` #112211

eval-exec commented Jun 2, 2023

rustbot commented Jun 2, 2023

onur-ozkan left a comment

onur-ozkan commented Jun 2, 2023

eval-exec commented Jun 2, 2023 •

edited

Loading

jyn514 commented Jun 2, 2023

eval-exec commented Jun 2, 2023

jyn514 commented Jun 2, 2023

onur-ozkan commented Jun 2, 2023

onur-ozkan commented Jun 2, 2023

This comment has been minimized.

eval-exec commented Jun 2, 2023 •

edited

Loading

onur-ozkan commented Jun 2, 2023 •

edited

Loading

eval-exec commented Jun 2, 2023

onur-ozkan commented Jun 2, 2023

bors commented Jun 2, 2023

jyn514 Jun 3, 2023

onur-ozkan Jun 3, 2023 •

edited

Loading

eval-exec Jun 3, 2023

pass --lib to x doc #112211

pass --lib to x doc #112211

Conversation

eval-exec commented Jun 2, 2023

rustbot commented Jun 2, 2023

onur-ozkan left a comment

Choose a reason for hiding this comment

onur-ozkan commented Jun 2, 2023

eval-exec commented Jun 2, 2023 • edited Loading

jyn514 commented Jun 2, 2023

eval-exec commented Jun 2, 2023

jyn514 commented Jun 2, 2023

onur-ozkan commented Jun 2, 2023

onur-ozkan commented Jun 2, 2023

This comment has been minimized.

eval-exec commented Jun 2, 2023 • edited Loading

onur-ozkan commented Jun 2, 2023 • edited Loading

eval-exec commented Jun 2, 2023

onur-ozkan commented Jun 2, 2023

bors commented Jun 2, 2023

jyn514 Jun 3, 2023

Choose a reason for hiding this comment

onur-ozkan Jun 3, 2023 • edited Loading

Choose a reason for hiding this comment

eval-exec Jun 3, 2023

Choose a reason for hiding this comment

pass `--lib` to `x doc` #112211

pass `--lib` to `x doc` #112211

eval-exec commented Jun 2, 2023 •

edited

Loading

eval-exec commented Jun 2, 2023 •

edited

Loading

onur-ozkan commented Jun 2, 2023 •

edited

Loading

onur-ozkan Jun 3, 2023 •

edited

Loading