rustdoc rfc#3662 changes under unstable flags #129337

EtomicBomb · 2024-08-20T23:52:28Z

All new functionality is under unstable options
Adds --merge=shared|none|finalize flags
Adds --parts-out-dir=<crate specific directory> for --merge=none
to write cross-crate info file for a single crate
Adds --include-parts-dir=<previously specified directory> for
--merge=finalize to write cross-crate info files
tests/rustdoc/ tests for the new flags

rustbot · 2024-08-20T23:52:36Z

rustbot has assigned @notriddle.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

rustbot · 2024-08-21T01:16:40Z

This PR modifies tests/run-make/. If this PR is trying to port a Makefile
run-make test to use rmake.rs, please update the
run-make port tracking issue
so we can track our progress. You can either modify the tracking issue
directly, or you can comment on the tracking issue and link this PR.

cc @jieyouxu

EtomicBomb · 2024-08-21T01:18:50Z

Just updated tests/run-make/rustdoc-default-output/output-default.stdout test to update the rustdoc --help golden file.

bors · 2024-08-30T00:01:57Z

☔ The latest upstream changes (presumably #129750) made this pull request unmergeable. Please resolve the merge conflicts.

notriddle

This code basically looks fine. I have no complaints about merging it as-is.

However, it would be a good idea to add a guide to the rustdoc book. That can be done after merging this.

notriddle · 2024-09-07T20:09:46Z

Also, the merge conflicts need fixed.

The `librustdoc::config::Options` struct no longer includes `rustc_session::config::Input`. This is so that Input can be optional. In rfc#3662, the crate input is not required if `--merge=finalize`. Replacing Input with Option<Input> was decided against. In most places that Input is needed, it should be statically known to not be optional (means fewer unwraps). We just want to have an Input-free Options in librustdoc::main_args, where we can run the write shared procedure.

* All new functionality is under unstable options * Adds `--merge=shared|none|finalize` flags * Adds `--parts-out-dir=<crate specific directory>` for `--merge=none` to write cross-crate info file for a single crate * Adds `--include-parts-dir=<previously specified directory>` for `--merge=finalize` to write cross-crate info files * update tests/run-make/rustdoc-default-output/rmake.rs golden

* Adds tests for the behavior from rfc#3662 in `tests/rustdoc/`

notriddle · 2024-09-08T00:41:15Z

@bors r+

bors · 2024-09-08T00:41:17Z

📌 Commit 548b6e1 has been approved by notriddle

It is now in the queue for this repository.

rustdoc rfc#3662 changes under unstable flags * All new functionality is under unstable options * Adds `--merge=shared|none|finalize` flags * Adds `--parts-out-dir=<crate specific directory>` for `--merge=none` to write cross-crate info file for a single crate * Adds `--include-parts-dir=<previously specified directory>` for `--merge=finalize` to write cross-crate info files * `tests/rustdoc/` tests for the new flags

…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#129337 (rustdoc rfc#3662 changes under unstable flags) - rust-lang#129473 (use `download-ci-llvm=true` in the default compiler config) - rust-lang#129529 (Add test to build crates used by r-a on stable) - rust-lang#130025 (Also emit `missing_docs` lint with `--test` to fulfil expectations) - rust-lang#130070 (Rename variant `AddrOfRegion` of `RegionVariableOrigin` to `BorrowRegion`) - rust-lang#130087 (remove 'const' from 'Option::iter') - rust-lang#130092 (Fixes typo in wasm32-wasip2 doc comment) r? `@ghost` `@rustbot` modify labels: rollup

matthiaskrgr · 2024-09-08T17:07:45Z

@bors r-
https://github.com/rust-lang-ci/rust/actions/runs/10761390746/job/29840547309#step:25:7606

matthiaskrgr · 2024-09-08T22:00:44Z

mmh looks like this is caused by something else..
@bors r=notriddle

bors · 2024-09-08T22:00:46Z

📌 Commit 548b6e1 has been approved by notriddle

It is now in the queue for this repository.

rustdoc rfc#3662 changes under unstable flags * All new functionality is under unstable options * Adds `--merge=shared|none|finalize` flags * Adds `--parts-out-dir=<crate specific directory>` for `--merge=none` to write cross-crate info file for a single crate * Adds `--include-parts-dir=<previously specified directory>` for `--merge=finalize` to write cross-crate info files * `tests/rustdoc/` tests for the new flags

notriddle · 2024-09-10T05:28:13Z

@bors r+

bors · 2024-09-10T05:28:16Z

💡 This pull request was already approved, no need to approve it again.

There's another pull request that is currently being tested, blocking this pull request: Rollup of 11 pull requests #130179

bors · 2024-09-10T05:28:17Z

📌 Commit 548b6e1 has been approved by notriddle

It is now in the queue for this repository.

bors · 2024-09-10T11:15:54Z

⌛ Testing commit 548b6e1 with merge f827364...

bors · 2024-09-10T13:43:51Z

☀️ Test successful - checks-actions
Approved by: notriddle
Pushing f827364 to master...

rust-timer · 2024-09-10T15:35:22Z

Finished benchmarking commit (f827364): comparison URL.

Overall result: no relevant changes - no action needed

@rustbot label: -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results (secondary 3.3%)

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	3.3%	[2.4%, 4.9%]	7
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-	-	0
All ❌✅ (primary)	-	-	0

Cycles

Results (secondary 1.3%)

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	7.0%	[3.5%, 9.5%]	4
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-3.2%	[-4.7%, -2.1%]	5
All ❌✅ (primary)	-	-	0

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 760.197s -> 755.942s (-0.56%)
Artifact size: 341.23 MiB -> 341.35 MiB (0.03%)

rustbot assigned notriddle Aug 20, 2024

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Aug 20, 2024

This comment has been minimized.

Sign in to view

EtomicBomb force-pushed the rfc branch from b528d6e to 87e4b12 Compare August 21, 2024 01:16

rustbot added the A-run-make Area: port run-make Makefiles to rmake.rs label Aug 21, 2024

EtomicBomb force-pushed the rfc branch 2 times, most recently from 96a1453 to cb044c6 Compare August 27, 2024 05:47

EtomicBomb force-pushed the rfc branch from cb044c6 to 404b531 Compare August 31, 2024 05:43

notriddle approved these changes Sep 7, 2024

View reviewed changes

EtomicBomb added 3 commits September 7, 2024 18:57

add tests for behavior in rfc#3662

548b6e1

* Adds tests for the behavior from rfc#3662 in `tests/rustdoc/`

EtomicBomb force-pushed the rfc branch from 404b531 to 548b6e1 Compare September 7, 2024 23:14

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 Sep 8, 2024

matthiaskrgr mentioned this pull request Sep 8, 2024

Rollup of 7 pull requests #130100

Closed

bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Sep 8, 2024

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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 8, 2024

workingjubilee mentioned this pull request Sep 9, 2024

Rollup of 19 pull requests #130127

Closed

workingjubilee closed this Sep 10, 2024

workingjubilee reopened this Sep 10, 2024

bors added the merged-by-bors This PR was explicitly merged by bors. label Sep 10, 2024

bors merged commit f827364 into rust-lang:master Sep 10, 2024
13 checks passed

rustbot added this to the 1.83.0 milestone Sep 10, 2024

camelid mentioned this pull request Sep 21, 2024

Tracking Issue for mergeable rustdoc cross-crate info #130676

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

rustdoc rfc#3662 changes under unstable flags #129337

rustdoc rfc#3662 changes under unstable flags #129337

EtomicBomb commented Aug 20, 2024 •

edited

Loading

rustbot commented Aug 20, 2024

This comment has been minimized.

rustbot commented Aug 21, 2024

EtomicBomb commented Aug 21, 2024 •

edited

Loading

bors commented Aug 30, 2024

notriddle left a comment

notriddle commented Sep 7, 2024

notriddle commented Sep 8, 2024

bors commented Sep 8, 2024

matthiaskrgr commented Sep 8, 2024

matthiaskrgr commented Sep 8, 2024

bors commented Sep 8, 2024

notriddle commented Sep 10, 2024

bors commented Sep 10, 2024

bors commented Sep 10, 2024

bors commented Sep 10, 2024

bors commented Sep 10, 2024

rust-timer commented Sep 10, 2024

rustdoc rfc#3662 changes under unstable flags #129337

rustdoc rfc#3662 changes under unstable flags #129337

Conversation

EtomicBomb commented Aug 20, 2024 • edited Loading

rustbot commented Aug 20, 2024

This comment has been minimized.

rustbot commented Aug 21, 2024

EtomicBomb commented Aug 21, 2024 • edited Loading

bors commented Aug 30, 2024

notriddle left a comment

Choose a reason for hiding this comment

notriddle commented Sep 7, 2024

notriddle commented Sep 8, 2024

bors commented Sep 8, 2024

matthiaskrgr commented Sep 8, 2024

matthiaskrgr commented Sep 8, 2024

bors commented Sep 8, 2024

notriddle commented Sep 10, 2024

bors commented Sep 10, 2024

bors commented Sep 10, 2024

bors commented Sep 10, 2024

bors commented Sep 10, 2024

rust-timer commented Sep 10, 2024

Overall result: no relevant changes - no action needed

Instruction count

Max RSS (memory usage)

Cycles

Binary size

EtomicBomb commented Aug 20, 2024 •

edited

Loading

EtomicBomb commented Aug 21, 2024 •

edited

Loading