Skip to content

Stabilize rustdoc --merge --parts-out-dir, and --include-parts-dir options#152902

Open
GuillaumeGomez wants to merge 1 commit intorust-lang:mainfrom
GuillaumeGomez:stabilize-rustdoc-merge-options
Open

Stabilize rustdoc --merge --parts-out-dir, and --include-parts-dir options#152902
GuillaumeGomez wants to merge 1 commit intorust-lang:mainfrom
GuillaumeGomez:stabilize-rustdoc-merge-options

Conversation

@GuillaumeGomez
Copy link
Member

@GuillaumeGomez GuillaumeGomez commented Feb 20, 2026

Fixes #130676.

Needs for #146220 to be merged first as these options would be less useful if --emit is not stable as well.

As discussed in the last rustdoc team meeting, the options can be stabilized as is.

cc @notriddle
r? @camelid

@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 Feb 20, 2026
@rust-log-analyzer

This comment has been minimized.

Copy link
Member

Choose a reason for hiding this comment

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

While mergeable info arguments standalone is great, it won't be that useful until we have --emit stabllilized I guess?

See rust-lang/cargo#16167 (comment)

@fmease fmease added the needs-fcp This change is insta-stable, or significant enough to need a team FCP to proceed. label Feb 20, 2026
Copy link
Member

@camelid camelid left a comment

Choose a reason for hiding this comment

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

Approval just for implementation (since we need FCP for the stabilization).

View changes since this review

Comment on lines +476 to +483
```console
$ rustdoc +nightly crate1.rs --merge=none --parts-out-dir=crate1.d -Zunstable-options
$ cat doc/search.index/crateNames/*
cat: 'doc/search.index/crateNames/*': No such file or directory
$ rustdoc +nightly crate2.rs --merge=finalize --include-parts-dir=crate1.d -Zunstable-options
$ cat doc/search.index/crateNames/*
rd_("fcrate1fcrate2")
```
Copy link
Member

Choose a reason for hiding this comment

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

Might be helpful to adjust the example to have another dependency crate too so we can show passing --include-parts-dir multiple times at once.

@camelid
Copy link
Member

camelid commented Feb 22, 2026

@rfcbot fcp merge

@rust-rfcbot
Copy link
Collaborator

Error encounted:
Provided team `` is invalid

@camelid
Copy link
Member

camelid commented Feb 22, 2026

@rfcbot concern wait for stabilization of --emit?

@camelid
Copy link
Member

camelid commented Feb 22, 2026

@rfcbot fcp merge rustdoc

@rust-rfcbot
Copy link
Collaborator

rust-rfcbot commented Feb 22, 2026

Team member @camelid has proposed to merge this. The next step is review by the rest of the tagged team members:

Concerns:

Once a majority of reviewers approve (and at most 2 approvals are outstanding), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up!

See this document for info about what commands tagged team members can give me.

@rust-rfcbot rust-rfcbot added proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. disposition-merge This issue / PR is in PFCP or FCP with a disposition to merge it. labels Feb 22, 2026
@camelid
Copy link
Member

camelid commented Feb 22, 2026

@rfcbot concern wait for stabilization of --emit?

@weihanglo
Copy link
Member

BTW, have we heard back from the Bazelz Buck2, and other build system communities that this is useful and comprehensive for them to integrate?

@max-heller
Copy link
Contributor

BTW, have we heard back from the Bazelz Buck2, and other build system communities that this is useful and comprehensive for them to integrate?

Here's the latest I know of from the Bazel side, there are plans but no proof of concept yet: bazelbuild/rules_rust#1837 (comment)

@GuillaumeGomez
Copy link
Member Author

I'll also stabilize --emit in this PR.

@GuillaumeGomez GuillaumeGomez force-pushed the stabilize-rustdoc-merge-options branch from 79f4541 to facb206 Compare February 23, 2026 14:48
@rustbot
Copy link
Collaborator

rustbot commented Feb 23, 2026

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

@fmease
Copy link
Member

fmease commented Feb 23, 2026

I'll also stabilize --emit in this PR.

What do you mean by this? #146220 is perfectly fine and can be merged before this PR once all 4 of its blocking concerns are resolved and its FCP has concluded.

@GuillaumeGomez
Copy link
Member Author

Let's put on that on tired monday... Removing my second commit then. I'll link to the other PR in my first message.

@GuillaumeGomez GuillaumeGomez force-pushed the stabilize-rustdoc-merge-options branch from facb206 to f447fab Compare February 23, 2026 14:55
@rust-log-analyzer

This comment has been minimized.

@GuillaumeGomez GuillaumeGomez force-pushed the stabilize-rustdoc-merge-options branch from f447fab to 8f3b559 Compare February 23, 2026 15:55
@rustbot rustbot added the A-run-make Area: port run-make Makefiles to rmake.rs label Feb 23, 2026
@GuillaumeGomez
Copy link
Member Author

And fixed the CI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-run-make Area: port run-make Makefiles to rmake.rs disposition-merge This issue / PR is in PFCP or FCP with a disposition to merge it. needs-fcp This change is insta-stable, or significant enough to need a team FCP to proceed. proposed-final-comment-period Proposed to merge/close by relevant subteam, see T-<team> label. Will enter FCP once signed off. 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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

rustdoc: Tracking issue for mergeable cross-crate info

8 participants