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

rustdoc rfc#3662 changes under unstable flags #129337

Merged
merged 3 commits into from
Sep 10, 2024
Merged

rustdoc rfc#3662 changes under unstable flags #129337

merged 3 commits into from
Sep 10, 2024

Conversation

EtomicBomb
Copy link
Contributor

@EtomicBomb EtomicBomb commented Aug 20, 2024 •
edited
Loading

  • 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
Copy link
Collaborator

rustbot commented Aug 20, 2024

r? @notriddle

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 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
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rustbot rustbot added the A-run-make Area: port run-make Makefiles to rmake.rs label Aug 21, 2024
@rustbot
Copy link
Collaborator

rustbot commented Aug 21, 2024

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
Copy link
Contributor Author

EtomicBomb commented Aug 21, 2024 •
edited
Loading

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

@bors
Copy link
Contributor

bors commented Aug 30, 2024

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

notriddle
notriddle approved these changes Sep 7, 2024
View reviewed changes
Copy link
Contributor

@notriddle notriddle left a comment

Choose a reason for hiding this comment

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

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
Copy link
Contributor

Also, the merge conflicts need fixed.

@EtomicBomb
librustdoc::config: removed Input from Options
3782251 
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.
@EtomicBomb
rfc#3662 changes under unstable flags
2e1cba6 
* 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
@EtomicBomb
add tests for behavior in rfc#3662
548b6e1 
* Adds tests for the behavior from rfc#3662 in `tests/rustdoc/`
@notriddle
Copy link
Contributor

@bors r+

@bors
Copy link
Contributor

bors commented Sep 8, 2024

📌 Commit 548b6e1 has been approved by notriddle

It is now in the queue for this repository.

@bors 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 added a commit to matthiaskrgr/rust that referenced this pull request Sep 8, 2024
@matthiaskrgr
Rollup merge of rust-lang#129337 - EtomicBomb:rfc, r=notriddle
0106b27 
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
@matthiaskrgr matthiaskrgr mentioned this pull request Sep 8, 2024
Closed
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 8, 2024
@bors
Auto merge of rust-lang#130100 - matthiaskrgr:rollup-nk36g91, r=matth…
537e9e5 
…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
Copy link
Member

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

@bors 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
@matthiaskrgr
Copy link
Member

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

@bors
Copy link
Contributor

bors commented Sep 8, 2024

📌 Commit 548b6e1 has been approved by notriddle

It is now in the queue for this repository.

@bors 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 added a commit to workingjubilee/rustc that referenced this pull request Sep 9, 2024
@workingjubilee
Rollup merge of rust-lang#129337 - EtomicBomb:rfc, r=notriddle
2a97310 
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
@workingjubilee workingjubilee mentioned this pull request Sep 9, 2024
Closed
@notriddle
Copy link
Contributor

@bors r+

@bors
Copy link
Contributor

bors commented Sep 10, 2024

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

@bors
Copy link
Contributor

bors commented Sep 10, 2024

📌 Commit 548b6e1 has been approved by notriddle

It is now in the queue for this repository.

@bors
Copy link
Contributor

bors commented Sep 10, 2024

⌛ Testing commit 548b6e1 with merge f827364...

@bors
Copy link
Contributor

bors commented Sep 10, 2024

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

@bors bors added the merged-by-bors This PR was explicitly merged by bors. label Sep 10, 2024
@bors bors merged commit f827364 into rust-lang:master Sep 10, 2024
13 checks passed
@rustbot rustbot added this to the 1.83.0 milestone Sep 10, 2024
@rust-timer
Copy link
Collaborator

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

@camelid camelid mentioned this pull request Sep 21, 2024
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@notriddle notriddle notriddle approved these changes

Assignees

@notriddle notriddle

Labels
A-run-make Area: port run-make Makefiles to rmake.rs merged-by-bors This PR was explicitly merged by bors. S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.83.0
Development

Successfully merging this pull request may close these issues.
8 participants
@EtomicBomb @rustbot @rust-log-analyzer @bors @notriddle @matthiaskrgr @rust-timer @workingjubilee