Skip to content

bootstrap: doc: document std crates one by one #157143

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

Open
Fabian-Gruenbichler wants to merge 1 commit into
base: main
Choose a base branch
from
+41 −30
Open

bootstrap: doc: document std crates one by one #157143

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
71 changes: 41 additions & 30 deletions src/bootstrap/src/core/build_steps/doc.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
//! Everything here is basically just a shim around calling either `rustbook` or
//! `rustdoc`.

use std::collections::HashMap;
use std::io::{self, Write};
use std::path::{Path, PathBuf};
use std::{env, fs, mem};
Expand Down Expand Up @@ -806,40 +807,50 @@ fn doc_std(
// as a function parameter.
let out_dir = target_dir.join(target).join("doc");

let mut cargo = builder::Cargo::new(
builder,
build_compiler,
Mode::Std,
SourceType::InTree,
target,
Kind::Doc,
);
let mut crates = requested_crates.to_vec();
let std_lib_crate_order = STD_PUBLIC_CRATES

@Mark-Simulacrum Mark-Simulacrum Jun 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think this is a regression in terms of needing STD_PUBLIC_CRATES again... right?

cc @jyn514 since you wrote #111955

@Fabian-Gruenbichler Fabian-Gruenbichler Jun 8, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yes, but it seems it is still required to document things in the right order. I am happy to fix this another way, but I haven't yet found a simple reproducer that allows me to figure out what takes a wrong turn where. if somebody has a clue, I am happy to take a closer look there :)

.iter()
.enumerate()
.map(|(i, v)| (v.to_string(), i))
.collect::<HashMap<_, _>>();
crates.sort_by_key(|c| std_lib_crate_order.get(c).unwrap_or(&usize::MAX));

@Kobzol Kobzol Jun 19, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is potentially non-deterministic, we should sort by a tuple (crate order [number], crate name).


compile::std_cargo(builder, target, &mut cargo, requested_crates);
cargo
.arg("--no-deps")
.arg("--target-dir")
.arg(&*target_dir.to_string_lossy())
.arg("-Zskip-rustdoc-fingerprint")
.arg("-Zrustdoc-map")
.rustdocflag("--extern-html-root-url")
.rustdocflag("std_detect=https://docs.rs/std_detect/latest/")
.rustdocflag("--extern-html-root-takes-precedence")
.rustdocflag("--resource-suffix")
.rustdocflag(&builder.version);
for arg in extra_args {
cargo.rustdocflag(arg);
}
for krate in crates {
let mut cargo = builder::Cargo::new(
builder,
build_compiler,
Mode::Std,
SourceType::InTree,
target,
Kind::Doc,
);

if builder.config.library_docs_private_items {
cargo.rustdocflag("--document-private-items").rustdocflag("--document-hidden-items");
}
compile::std_cargo(builder, target, &mut cargo, std::slice::from_ref(&krate));

@Kobzol Kobzol Jun 19, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
compile::std_cargo(builder, target, &mut cargo, std::slice::from_ref(&krate));
compile::std_cargo(builder, target, &mut cargo, &[krate]);

cargo
.arg("--no-deps")
.arg("--target-dir")
.arg(&*target_dir.to_string_lossy())

@Mark-Simulacrum Mark-Simulacrum Jun 7, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It's preexisting, but I think we should be able to just pass target_dir here? Cargo::arg should take Path/OsStr.

.arg("-Zskip-rustdoc-fingerprint")
.arg("-Zrustdoc-map")
.rustdocflag("--extern-html-root-url")
.rustdocflag("std_detect=https://docs.rs/std_detect/latest/")
.rustdocflag("--extern-html-root-takes-precedence")
.rustdocflag("--resource-suffix")
.rustdocflag(&builder.version);
for arg in extra_args {
cargo.rustdocflag(arg);
}

let description =
format!("library{} in {} format", crate_description(requested_crates), format.as_str());
let _guard = builder.msg(Kind::Doc, description, Mode::Std, build_compiler, target);
if builder.config.library_docs_private_items {
cargo.rustdocflag("--document-private-items").rustdocflag("--document-hidden-items");
}

let description =
format!("library{} in {} format", crate_description(&[krate]), format.as_str());
let _guard = builder.msg(Kind::Doc, description, Mode::Std, build_compiler, target);
cargo.into_cmd().run(builder);
}

cargo.into_cmd().run(builder);
builder.cp_link_r(&out_dir, out);
}

Expand Down
Loading