Skip to content

fix(rustdoc): switch to new --emit options #16739

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

Merged
weihanglo merged 1 commit into from
Mar 12, 2026
+7 −7
Merged

fix(rustdoc): switch to new --emit options #16739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/cargo/core/compiler/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -876,14 +876,14 @@ fn prepare_rustdoc(build_runner: &BuildRunner<'_, '_>, unit: &Unit) -> CargoResu
add_allow_features(build_runner, &mut rustdoc);

if build_runner.bcx.gctx.cli_unstable().rustdoc_depinfo {
// toolchain-shared-resources is required for keeping the shared styling resources
// invocation-specific is required for keeping the original rustdoc emission
// html-static-files is required for keeping the shared styling resources
// html-non-static-files is required for keeping the original rustdoc emission
let mut arg = if build_runner.bcx.gctx.cli_unstable().rustdoc_mergeable_info {
// toolchain resources are written at the end, at the same time as merging
OsString::from("--emit=invocation-specific,dep-info=")
OsString::from("--emit=html-non-static-files,dep-info=")
} else {
// if not using mergeable CCI, everything is written every time
OsString::from("--emit=toolchain-shared-resources,invocation-specific,dep-info=")
OsString::from("--emit=html-static-files,html-non-static-files,dep-info=")
};
arg.push(rustdoc_dep_info_loc(build_runner, unit));
rustdoc.arg(arg);
Expand All @@ -895,7 +895,7 @@ fn prepare_rustdoc(build_runner: &BuildRunner<'_, '_>, unit: &Unit) -> CargoResu
rustdoc.arg("-Zunstable-options");
} else if build_runner.bcx.gctx.cli_unstable().rustdoc_mergeable_info {
// toolchain resources are written at the end, at the same time as merging
rustdoc.arg("--emit=invocation-specific");
rustdoc.arg("--emit=html-non-static-files");
rustdoc.arg("-Zunstable-options");
}

Expand Down
4 changes: 2 additions & 2 deletions tests/testsuite/doc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3653,7 +3653,7 @@ fn mergeable_info_rebuild_with_depinfo() {
.with_stderr_data(
str![[r#"
[DOCUMENTING] foo v0.0.0 ([ROOT]/foo)
[RUNNING] `rustdoc [..]--crate-name foo [..]--emit=invocation-specific,dep-info=[..] --merge=none --parts-out-dir=[ROOT]/foo/target/debug/build/foo-[HASH]/out [..]`
[RUNNING] `rustdoc [..]--crate-name foo [..]--emit=html-non-static-files,dep-info=[..] --merge=none --parts-out-dir=[ROOT]/foo/target/debug/build/foo-[HASH]/out [..]`
[FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
[MERGING] 1 doc for host
[RUNNING] `rustdoc -o [ROOT]/foo/target/doc -Zunstable-options --merge=finalize --include-parts-dir=[ROOT]/foo/target/debug/build/foo-[HASH]/out`
Expand Down Expand Up @@ -3717,7 +3717,7 @@ fn mergeable_info_rebuild_with_depinfo() {
str![[r#"
[DIRTY] foo v0.0.0 ([ROOT]/foo): the file `src/lib.rs` has changed ([TIME_DIFF_AFTER_LAST_BUILD])
[DOCUMENTING] foo v0.0.0 ([ROOT]/foo)
[RUNNING] `rustdoc [..]--crate-name foo [..]--emit=invocation-specific,dep-info=[..] --merge=none --parts-out-dir=[ROOT]/foo/target/debug/build/foo-[HASH]/out [..]`
[RUNNING] `rustdoc [..]--crate-name foo [..]--emit=html-non-static-files,dep-info=[..] --merge=none --parts-out-dir=[ROOT]/foo/target/debug/build/foo-[HASH]/out [..]`
[FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
[MERGING] 1 doc for host
[RUNNING] `rustdoc -o [ROOT]/foo/target/doc -Zunstable-options --merge=finalize --include-parts-dir=[ROOT]/foo/target/debug/build/foo-[HASH]/out`
Expand Down